hyperx.api

   1from __future__ import annotations
   2from ..library import _api, _types
   3
   4from ..api import types
   5from typing import TypeVar, Generic, overload
   6from enum import Enum
   7from System.Collections.Generic import List, IEnumerable, Dictionary, HashSet
   8from System.Threading.Tasks import Task
   9from System import Guid, DateTime, Action
  10
  11from abc import ABC, abstractmethod
  12
  13T = TypeVar('T')
  14
  15def MakeCSharpIntList(ints: list[int]) -> List[int]:
  16	intsList = List[int]()
  17	if ints is not None:
  18		for thing in ints:
  19			if thing is not None:
  20				intsList.Add(thing)
  21	
  22	return intsList
  23
  24class AnalysisResultToReturn(Enum):
  25	'''
  26	Used to specify which analysis result to return.
  27	'''
  28	Limit = 1
  29	Ultimate = 2
  30	Minimum = 3
  31
  32class CollectionModificationStatus(Enum):
  33	'''
  34	Indicates whether a collection was manipulated successfully.
  35	'''
  36	Success = 1
  37	DuplicateIdFailure = 2
  38	EntityMissingAddFailure = 3
  39	EntityMissingRemovalFailure = 4
  40	FemConnectionFailure = 5
  41	RunSetUsageFailure = 6
  42	EntityRemovalDependencyFailure = 7
  43
  44class CreateDatabaseStatus(Enum):
  45	Success = 1
  46	TemplateNotFound = 2
  47	ImproperExtension = 3
  48
  49class MaterialCreationStatus(Enum):
  50	'''
  51	Indicates whether a material was created successfully. 
  52            If not, this indicates why the material was not created.
  53	'''
  54	Success = 1
  55	DuplicateNameFailure = 2
  56	DuplicateFemIdFailure = 3
  57	MissingMaterialToCopy = 4
  58
  59class DbForceUnit(Enum):
  60	Pounds = 1
  61	Newtons = 2
  62	Dekanewtons = 4
  63
  64class DbLengthUnit(Enum):
  65	Inches = 1
  66	Feet = 2
  67	Meters = 3
  68	Centimeters = 4
  69	Millimeters = 5
  70
  71class DbMassUnit(Enum):
  72	Pounds = 1
  73	Kilograms = 2
  74	Slinches = 4
  75	Slugs = 5
  76	Megagrams = 6
  77
  78class DbTemperatureUnit(Enum):
  79	Fahrenheit = 1
  80	Rankine = 2
  81	Celsius = 3
  82	Kelvin = 4
  83
  84class ProjectCreationStatus(Enum):
  85	'''
  86	Indicates whether a project was created successfully. 
  87            If not, this indicates why the project was not created.
  88	'''
  89	Success = 1
  90	Failure = 2
  91	DuplicateNameFailure = 3
  92
  93class ProjectDeletionStatus(Enum):
  94	'''
  95	Indicates whether a project was deleted successfully. 
  96            If not, this indicates why the project was not deleted.
  97	'''
  98	Success = 1
  99	Failure = 2
 100	ProjectDoesNotExistFailure = 3
 101	ActiveProjectFailure = 4
 102
 103class SetUnitsStatus(Enum):
 104	Success = 1
 105	Error = 2
 106	MixedUnitSystemError = 3
 107
 108class PropertyAssignmentStatus(Enum):
 109	Success = 1
 110	Failure = 2
 111	FailureCollectionAssignment = 3
 112	PropertyIsNull = 4
 113	PropertyNotFoundInDb = 5
 114	EmptyCollection = 6
 115	IncompatiblePropertyAssignment = 7
 116	EntityDoesNotExist = 8
 117
 118class RundeckBulkUpdateStatus(Enum):
 119	NoRundecksUpdated = 0
 120	Success = 1
 121	InputFilePathDoesNotExist = 2
 122	ResultFilePathDoesNotExist = 3
 123	InputFilePathAlreadyExists = 4
 124	ResultFilePathAlreadyExists = 5
 125	InvalidPathCount = 6
 126	RundeckBulkUpdateFailure = 7
 127	SuccessButIncompatibleFem = 8
 128
 129class RundeckCreationStatus(Enum):
 130	Success = 1
 131	InputFilePathAlreadyExists = 2
 132	ResultFilePathAlreadyExists = 3
 133
 134class RundeckRemoveStatus(Enum):
 135	Success = 1
 136	InvalidId = 2
 137	CannotRemoveLastRundeck = 3
 138	CannotDeletePrimaryRundeck = 4
 139	RundeckNotFound = 5
 140	RundeckRemoveFailure = 6
 141	SuccessButIncompatibleFem = 7
 142
 143class RundeckUpdateStatus(Enum):
 144	Success = 1
 145	InvalidId = 2
 146	IdDoesNotExist = 3
 147	RundeckAlreadyPrimary = 4
 148	InputPathInUse = 5
 149	ResultPathInUse = 6
 150	RundeckCommitFailure = 7
 151	InputPathDoesNotExist = 8
 152	ResultPathDoesNotExist = 9
 153	SuccessButIncompatibleFem = 10
 154
 155class ZoneCreationStatus(Enum):
 156	'''
 157	Indicates whether a zone was created successfully. 
 158            If not, this indicates why the zone was not created.
 159	'''
 160	Success = 1
 161	DuplicateNameFailure = 2
 162	InvalidFamilyCategory = 3
 163
 164class ZoneIdUpdateStatus(Enum):
 165	Success = 1
 166	DuplicateIdFailure = 2
 167	IdOutOfRangeError = 3
 168
 169class UnitSystem(Enum):
 170	'''
 171	Unit system specified when starting a scripting Application.
 172	'''
 173	English = 1
 174	SI = 2
 175
 176class IdEntity(ABC):
 177	'''
 178	Represents an entity with an ID.
 179	'''
 180	def __init__(self, idEntity: _api.IdEntity):
 181		self._Entity = idEntity
 182
 183	@property
 184	def Id(self) -> int:
 185		return self._Entity.Id
 186
 187
 188class IdNameEntity(IdEntity):
 189	'''
 190	Represents an entity with an ID and Name.
 191	'''
 192	def __init__(self, idNameEntity: _api.IdNameEntity):
 193		self._Entity = idNameEntity
 194
 195	@property
 196	def Name(self) -> str:
 197		return self._Entity.Name
 198
 199class AnalysisDefinition(IdNameEntity):
 200	def __init__(self, analysisDefinition: _api.AnalysisDefinition):
 201		self._Entity = analysisDefinition
 202
 203	@property
 204	def AnalysisId(self) -> int:
 205		return self._Entity.AnalysisId
 206
 207	@property
 208	def Description(self) -> str:
 209		return self._Entity.Description
 210
 211
 212class Margin:
 213	'''
 214	Represents a Margin result.
 215	'''
 216	def __init__(self, margin: _api.Margin):
 217		self._Entity = margin
 218
 219	@property
 220	def AdjustedMargin(self) -> float:
 221		return self._Entity.AdjustedMargin
 222
 223	@property
 224	def IsFailureCode(self) -> bool:
 225		return self._Entity.IsFailureCode
 226
 227	@property
 228	def IsInformationalCode(self) -> bool:
 229		return self._Entity.IsInformationalCode
 230
 231	@property
 232	def MarginCode(self) -> types.MarginCode:
 233		return types.MarginCode[self._Entity.MarginCode.ToString()]
 234
 235
 236class AnalysisResult(ABC):
 237	'''
 238	Contains result information for an analysis
 239	'''
 240	def __init__(self, analysisResult: _api.AnalysisResult):
 241		self._Entity = analysisResult
 242
 243	@property
 244	def LimitUltimate(self) -> types.LimitUltimate:
 245		'''
 246		Limit vs Ultimate loads.
 247		'''
 248		return types.LimitUltimate[self._Entity.LimitUltimate.ToString()]
 249
 250	@property
 251	def LoadCaseId(self) -> int:
 252		return self._Entity.LoadCaseId
 253
 254	@property
 255	def Margin(self) -> Margin:
 256		'''
 257		Represents a Margin result.
 258		'''
 259		result = self._Entity.Margin
 260		return Margin(result) if result is not None else None
 261
 262	@property
 263	def AnalysisDefinition(self) -> AnalysisDefinition:
 264		result = self._Entity.AnalysisDefinition
 265		return AnalysisDefinition(result) if result is not None else None
 266
 267
 268class JointAnalysisResult(AnalysisResult):
 269	def __init__(self, jointAnalysisResult: _api.JointAnalysisResult):
 270		self._Entity = jointAnalysisResult
 271
 272	@property
 273	def ObjectId(self) -> types.JointObject:
 274		'''
 275		Enum identifying the possible entities within a joint
 276		'''
 277		return types.JointObject[self._Entity.ObjectId.ToString()]
 278
 279
 280class ZoneAnalysisConceptResult(AnalysisResult):
 281	def __init__(self, zoneAnalysisConceptResult: _api.ZoneAnalysisConceptResult):
 282		self._Entity = zoneAnalysisConceptResult
 283
 284	@property
 285	def ConceptId(self) -> types.FamilyConceptUID:
 286		return types.FamilyConceptUID[self._Entity.ConceptId.ToString()]
 287
 288
 289class ZoneAnalysisObjectResult(AnalysisResult):
 290	def __init__(self, zoneAnalysisObjectResult: _api.ZoneAnalysisObjectResult):
 291		self._Entity = zoneAnalysisObjectResult
 292
 293	@property
 294	def ObjectId(self) -> types.FamilyObjectUID:
 295		return types.FamilyObjectUID[self._Entity.ObjectId.ToString()]
 296
 297
 298class AssignableProperty(IdNameEntity):
 299	def __init__(self, assignableProperty: _api.AssignableProperty):
 300		self._Entity = assignableProperty
 301
 302
 303class AssignablePropertyWithFamilyCategory(AssignableProperty):
 304	def __init__(self, assignablePropertyWithFamilyCategory: _api.AssignablePropertyWithFamilyCategory):
 305		self._Entity = assignablePropertyWithFamilyCategory
 306
 307	@property
 308	def FamilyCategory(self) -> types.FamilyCategory:
 309		return types.FamilyCategory[self._Entity.FamilyCategory.ToString()]
 310
 311
 312class FailureObjectGroup(IdNameEntity):
 313	def __init__(self, failureObjectGroup: _api.FailureObjectGroup):
 314		self._Entity = failureObjectGroup
 315
 316	@property
 317	def ObjectGroup(self) -> types.ObjectGroup:
 318		return types.ObjectGroup[self._Entity.ObjectGroup.ToString()]
 319
 320	@property
 321	def IsEnabled(self) -> bool:
 322		return self._Entity.IsEnabled
 323
 324	@property
 325	def LimitUltimate(self) -> types.LimitUltimate:
 326		'''
 327		Limit vs Ultimate loads.
 328		'''
 329		return types.LimitUltimate[self._Entity.LimitUltimate.ToString()]
 330
 331	@property
 332	def RequiredMargin(self) -> float:
 333		return self._Entity.RequiredMargin
 334
 335	@IsEnabled.setter
 336	def IsEnabled(self, value: bool) -> None:
 337		self._Entity.IsEnabled = value
 338
 339	@LimitUltimate.setter
 340	def LimitUltimate(self, value: types.LimitUltimate) -> None:
 341		self._Entity.LimitUltimate = _types.LimitUltimate(value.value)
 342
 343	@RequiredMargin.setter
 344	def RequiredMargin(self, value: float) -> None:
 345		self._Entity.RequiredMargin = value
 346
 347
 348class FailureSetting(IdNameEntity):
 349	'''
 350	Setting for a Failure Mode or a Failure Criteria.
 351	'''
 352	def __init__(self, failureSetting: _api.FailureSetting):
 353		self._Entity = failureSetting
 354
 355	@property
 356	def CategoryId(self) -> int:
 357		return self._Entity.CategoryId
 358
 359	@property
 360	def DataType(self) -> types.UserConstantDataType:
 361		return types.UserConstantDataType[self._Entity.DataType.ToString()]
 362
 363	@property
 364	def DefaultValue(self) -> str:
 365		return self._Entity.DefaultValue
 366
 367	@property
 368	def Description(self) -> str:
 369		return self._Entity.Description
 370
 371	@property
 372	def EnumValues(self) -> dict[int, str]:
 373		enumValuesDict = {}
 374		for kvp in self._Entity.EnumValues:
 375			enumValuesDict[int(kvp.Key)] = str(kvp.Value)
 376
 377		return enumValuesDict
 378
 379	@property
 380	def PackageId(self) -> int:
 381		return self._Entity.PackageId
 382
 383	@property
 384	def PackageSettingId(self) -> int:
 385		return self._Entity.PackageSettingId
 386
 387	@property
 388	def UID(self) -> Guid:
 389		return self._Entity.UID
 390
 391	@property
 392	def Value(self) -> str:
 393		return self._Entity.Value
 394
 395	def SetStringValue(self, value: str) -> None:
 396		return self._Entity.SetStringValue(value)
 397
 398	def SetIntValue(self, value: int) -> None:
 399		return self._Entity.SetIntValue(value)
 400
 401	def SetFloatValue(self, value: float) -> None:
 402		return self._Entity.SetFloatValue(value)
 403
 404	def SetBoolValue(self, value: bool) -> None:
 405		return self._Entity.SetBoolValue(value)
 406
 407	def SetSelectionValue(self, index: int) -> None:
 408		return self._Entity.SetSelectionValue(index)
 409
 410
 411class IdEntityCol(Generic[T], ABC):
 412	def __init__(self, idEntityCol: _api.IdEntityCol):
 413		self._Entity = idEntityCol
 414
 415	@property
 416	def IdEntityColList(self) -> tuple[IdEntity]:
 417		if self._Entity.Count() <= 0:
 418			return ()
 419		thisClass = type(self._Entity._items[0]).__name__
 420		givenClass = IdEntity
 421		for subclass in IdEntity.__subclasses__():
 422			if subclass.__name__ == thisClass:
 423				givenClass = subclass
 424		return tuple([givenClass(idEntityCol) for idEntityCol in self._Entity])
 425
 426	@property
 427	def Ids(self) -> tuple[int]:
 428		return tuple([int(int32) for int32 in self._Entity.Ids])
 429
 430	def Contains(self, id: int) -> bool:
 431		return self._Entity.Contains(id)
 432
 433	def Count(self) -> int:
 434		return self._Entity.Count()
 435
 436	def Get(self, id: int) -> T:
 437		return self._Entity.Get(id)
 438
 439	def __getitem__(self, index: int):
 440		return self.IdEntityColList[index]
 441
 442	def __iter__(self):
 443		yield from self.IdEntityColList
 444
 445	def __len__(self):
 446		return len(self.IdEntityColList)
 447
 448
 449class IdNameEntityCol(IdEntityCol, Generic[T]):
 450	def __init__(self, idNameEntityCol: _api.IdNameEntityCol):
 451		self._Entity = idNameEntityCol
 452		self._CollectedClass = T
 453
 454	@property
 455	def IdNameEntityColList(self) -> tuple[T]:
 456		if self._Entity.Count() <= 0:
 457			return ()
 458		thisClass = type(self._Entity._items[0]).__name__
 459		givenClass = T
 460		for subclass in T.__subclasses__():
 461			if subclass.__name__ == thisClass:
 462				givenClass = subclass
 463		return tuple([givenClass(idNameEntityCol) for idNameEntityCol in self._Entity])
 464
 465	@property
 466	def Names(self) -> tuple[str]:
 467		return tuple([str(string) for string in self._Entity.Names])
 468
 469	@overload
 470	def Get(self, name: str) -> T: ...
 471
 472	@overload
 473	def Get(self, id: int) -> T: ...
 474
 475	def Get(self, item1 = None) -> T:
 476		if isinstance(item1, str):
 477			return self._Entity.Get(item1)
 478
 479		if isinstance(item1, int):
 480			return super().Get(item1)
 481
 482		return self._Entity.Get(item1)
 483
 484	def __getitem__(self, index: int):
 485		return self.IdNameEntityColList[index]
 486
 487	def __iter__(self):
 488		yield from self.IdNameEntityColList
 489
 490	def __len__(self):
 491		return len(self.IdNameEntityColList)
 492
 493
 494class FailureObjectGroupCol(IdNameEntityCol[FailureObjectGroup]):
 495	def __init__(self, failureObjectGroupCol: _api.FailureObjectGroupCol):
 496		self._Entity = failureObjectGroupCol
 497		self._CollectedClass = FailureObjectGroup
 498
 499	@property
 500	def FailureObjectGroupColList(self) -> tuple[FailureObjectGroup]:
 501		return tuple([FailureObjectGroup(failureObjectGroupCol) for failureObjectGroupCol in self._Entity])
 502
 503	@overload
 504	def Get(self, objectGroup: types.ObjectGroup) -> FailureObjectGroup: ...
 505
 506	@overload
 507	def Get(self, name: str) -> FailureObjectGroup: ...
 508
 509	@overload
 510	def Get(self, id: int) -> FailureObjectGroup: ...
 511
 512	def Get(self, item1 = None) -> FailureObjectGroup:
 513		if isinstance(item1, types.ObjectGroup):
 514			return FailureObjectGroup(self._Entity.Get(_types.ObjectGroup(item1.value)))
 515
 516		if isinstance(item1, str):
 517			return FailureObjectGroup(super().Get(item1))
 518
 519		if isinstance(item1, int):
 520			return FailureObjectGroup(super().Get(item1))
 521
 522		return FailureObjectGroup(self._Entity.Get(_types.ObjectGroup(item1.value)))
 523
 524	def __getitem__(self, index: int):
 525		return self.FailureObjectGroupColList[index]
 526
 527	def __iter__(self):
 528		yield from self.FailureObjectGroupColList
 529
 530	def __len__(self):
 531		return len(self.FailureObjectGroupColList)
 532
 533
 534class FailureSettingCol(IdNameEntityCol[FailureSetting]):
 535	def __init__(self, failureSettingCol: _api.FailureSettingCol):
 536		self._Entity = failureSettingCol
 537		self._CollectedClass = FailureSetting
 538
 539	@property
 540	def FailureSettingColList(self) -> tuple[FailureSetting]:
 541		return tuple([FailureSetting(failureSettingCol) for failureSettingCol in self._Entity])
 542
 543	@overload
 544	def Get(self, name: str) -> FailureSetting: ...
 545
 546	@overload
 547	def Get(self, id: int) -> FailureSetting: ...
 548
 549	def Get(self, item1 = None) -> FailureSetting:
 550		if isinstance(item1, str):
 551			return FailureSetting(super().Get(item1))
 552
 553		if isinstance(item1, int):
 554			return FailureSetting(super().Get(item1))
 555
 556		result = self._Entity.Get(item1)
 557		thisClass = type(result).__name__
 558		givenClass = FailureSetting
 559		for subclass in FailureSetting.__subclasses__():
 560			if subclass.__name__ == thisClass:
 561				givenClass = subclass
 562		return givenClass(result)
 563
 564	def __getitem__(self, index: int):
 565		return self.FailureSettingColList[index]
 566
 567	def __iter__(self):
 568		yield from self.FailureSettingColList
 569
 570	def __len__(self):
 571		return len(self.FailureSettingColList)
 572
 573
 574class FailureCriterion(IdNameEntity):
 575	def __init__(self, failureCriterion: _api.FailureCriterion):
 576		self._Entity = failureCriterion
 577
 578	@property
 579	def Description(self) -> str:
 580		return self._Entity.Description
 581
 582	@property
 583	def IsEnabled(self) -> bool:
 584		return self._Entity.IsEnabled
 585
 586	@property
 587	def LimitUltimate(self) -> types.LimitUltimate:
 588		return types.LimitUltimate[self._Entity.LimitUltimate.ToString()]
 589
 590	@property
 591	def ObjectGroups(self) -> FailureObjectGroupCol:
 592		result = self._Entity.ObjectGroups
 593		return FailureObjectGroupCol(result) if result is not None else None
 594
 595	@property
 596	def RequiredMargin(self) -> float:
 597		return self._Entity.RequiredMargin
 598
 599	@property
 600	def Settings(self) -> FailureSettingCol:
 601		result = self._Entity.Settings
 602		return FailureSettingCol(result) if result is not None else None
 603
 604	@IsEnabled.setter
 605	def IsEnabled(self, value: bool) -> None:
 606		self._Entity.IsEnabled = value
 607
 608	@LimitUltimate.setter
 609	def LimitUltimate(self, value: types.LimitUltimate) -> None:
 610		self._Entity.LimitUltimate = _types.LimitUltimate(value.value)
 611
 612	@RequiredMargin.setter
 613	def RequiredMargin(self, value: float) -> None:
 614		self._Entity.RequiredMargin = value
 615
 616
 617class IdNameEntityRenameable(IdNameEntity):
 618	def __init__(self, idNameEntityRenameable: _api.IdNameEntityRenameable):
 619		self._Entity = idNameEntityRenameable
 620
 621	def Rename(self, name: str) -> None:
 622		return self._Entity.Rename(name)
 623
 624
 625class FailureCriterionCol(IdNameEntityCol[FailureCriterion]):
 626	def __init__(self, failureCriterionCol: _api.FailureCriterionCol):
 627		self._Entity = failureCriterionCol
 628		self._CollectedClass = FailureCriterion
 629
 630	@property
 631	def FailureCriterionColList(self) -> tuple[FailureCriterion]:
 632		return tuple([FailureCriterion(failureCriterionCol) for failureCriterionCol in self._Entity])
 633
 634	@overload
 635	def Get(self, name: str) -> FailureCriterion: ...
 636
 637	@overload
 638	def Get(self, id: int) -> FailureCriterion: ...
 639
 640	def Get(self, item1 = None) -> FailureCriterion:
 641		if isinstance(item1, str):
 642			return FailureCriterion(super().Get(item1))
 643
 644		if isinstance(item1, int):
 645			return FailureCriterion(super().Get(item1))
 646
 647		return FailureCriterion(self._Entity.Get(item1))
 648
 649	def __getitem__(self, index: int):
 650		return self.FailureCriterionColList[index]
 651
 652	def __iter__(self):
 653		yield from self.FailureCriterionColList
 654
 655	def __len__(self):
 656		return len(self.FailureCriterionColList)
 657
 658
 659class FailureMode(IdNameEntityRenameable):
 660	def __init__(self, failureMode: _api.FailureMode):
 661		self._Entity = failureMode
 662
 663	@property
 664	def AnalysisCategoryId(self) -> int:
 665		return self._Entity.AnalysisCategoryId
 666
 667	@property
 668	def AnalysisCategoryName(self) -> str:
 669		return self._Entity.AnalysisCategoryName
 670
 671	@property
 672	def Criteria(self) -> FailureCriterionCol:
 673		result = self._Entity.Criteria
 674		return FailureCriterionCol(result) if result is not None else None
 675
 676	@property
 677	def Settings(self) -> FailureSettingCol:
 678		result = self._Entity.Settings
 679		return FailureSettingCol(result) if result is not None else None
 680
 681
 682class FailureModeCol(IdNameEntityCol[FailureMode]):
 683	def __init__(self, failureModeCol: _api.FailureModeCol):
 684		self._Entity = failureModeCol
 685		self._CollectedClass = FailureMode
 686
 687	@property
 688	def FailureModeColList(self) -> tuple[FailureMode]:
 689		return tuple([FailureMode(failureModeCol) for failureModeCol in self._Entity])
 690
 691	@overload
 692	def CreateFailureMode(self, failureModeCategoryId: int, name: str = None) -> FailureMode: ...
 693
 694	@overload
 695	def CreateFailureMode(self, failureModeCategory: str, name: str = None) -> FailureMode: ...
 696
 697	@overload
 698	def Get(self, name: str) -> FailureMode: ...
 699
 700	@overload
 701	def Get(self, id: int) -> FailureMode: ...
 702
 703	def CreateFailureMode(self, item1 = None, item2 = None) -> FailureMode:
 704		if isinstance(item1, int) and isinstance(item2, str):
 705			return FailureMode(self._Entity.CreateFailureMode(item1, item2))
 706
 707		if isinstance(item1, str) and isinstance(item2, str):
 708			return FailureMode(self._Entity.CreateFailureMode(item1, item2))
 709
 710		return FailureMode(self._Entity.CreateFailureMode(item1, item2))
 711
 712	def Get(self, item1 = None) -> FailureMode:
 713		if isinstance(item1, str):
 714			return FailureMode(super().Get(item1))
 715
 716		if isinstance(item1, int):
 717			return FailureMode(super().Get(item1))
 718
 719		return FailureMode(self._Entity.Get(item1))
 720
 721	def __getitem__(self, index: int):
 722		return self.FailureModeColList[index]
 723
 724	def __iter__(self):
 725		yield from self.FailureModeColList
 726
 727	def __len__(self):
 728		return len(self.FailureModeColList)
 729
 730
 731class AnalysisProperty(AssignablePropertyWithFamilyCategory):
 732	def __init__(self, analysisProperty: _api.AnalysisProperty):
 733		self._Entity = analysisProperty
 734
 735	@property
 736	def FailureModes(self) -> FailureModeCol:
 737		result = self._Entity.FailureModes
 738		return FailureModeCol(result) if result is not None else None
 739
 740	@overload
 741	def AddFailureMode(self, id: int) -> None: ...
 742
 743	@overload
 744	def AddFailureMode(self, ids: tuple[int]) -> None: ...
 745
 746	@overload
 747	def RemoveFailureMode(self, id: int) -> None: ...
 748
 749	@overload
 750	def RemoveFailureMode(self, ids: tuple[int]) -> None: ...
 751
 752	def AddFailureMode(self, item1 = None) -> None:
 753		if isinstance(item1, int):
 754			return self._Entity.AddFailureMode(item1)
 755
 756		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
 757			idsList = MakeCSharpIntList(item1)
 758			idsEnumerable = IEnumerable(idsList)
 759			return self._Entity.AddFailureMode(idsEnumerable)
 760
 761		return self._Entity.AddFailureMode(item1)
 762
 763	def RemoveFailureMode(self, item1 = None) -> None:
 764		if isinstance(item1, int):
 765			return self._Entity.RemoveFailureMode(item1)
 766
 767		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
 768			idsList = MakeCSharpIntList(item1)
 769			idsEnumerable = IEnumerable(idsList)
 770			return self._Entity.RemoveFailureMode(idsEnumerable)
 771
 772		return self._Entity.RemoveFailureMode(item1)
 773
 774
 775class DesignProperty(AssignablePropertyWithFamilyCategory):
 776	def __init__(self, designProperty: _api.DesignProperty):
 777		self._Entity = designProperty
 778
 779	def Copy(self, newName: str = None) -> DesignProperty:
 780		result = self._Entity.Copy(newName)
 781		thisClass = type(result).__name__
 782		givenClass = DesignProperty
 783		for subclass in DesignProperty.__subclasses__():
 784			if subclass.__name__ == thisClass:
 785				givenClass = subclass
 786		return givenClass(result)
 787
 788
 789class LoadProperty(AssignableProperty):
 790	def __init__(self, loadProperty: _api.LoadProperty):
 791		self._Entity = loadProperty
 792
 793	@property
 794	def Category(self) -> types.FamilyCategory:
 795		return types.FamilyCategory[self._Entity.Category.ToString()]
 796
 797	@property
 798	def Type(self) -> types.LoadPropertyType:
 799		return types.LoadPropertyType[self._Entity.Type.ToString()]
 800
 801	@property
 802	def IsZeroCurvature(self) -> bool:
 803		return self._Entity.IsZeroCurvature
 804
 805	@property
 806	def ModificationDate(self) -> DateTime:
 807		return self._Entity.ModificationDate
 808
 809
 810class DesignLoadSubcase(IdNameEntity):
 811	def __init__(self, designLoadSubcase: _api.DesignLoadSubcase):
 812		self._Entity = designLoadSubcase
 813
 814	@property
 815	def RunDeckId(self) -> int:
 816		return self._Entity.RunDeckId
 817
 818	@property
 819	def IsThermal(self) -> bool:
 820		return self._Entity.IsThermal
 821
 822	@property
 823	def IsEditable(self) -> bool:
 824		return self._Entity.IsEditable
 825
 826	@property
 827	def Description(self) -> str:
 828		return self._Entity.Description
 829
 830	@property
 831	def ModificationDate(self) -> DateTime:
 832		return self._Entity.ModificationDate
 833
 834	@property
 835	def NastranSubcaseId(self) -> int:
 836		return self._Entity.NastranSubcaseId
 837
 838	@property
 839	def NastranLoadId(self) -> int:
 840		return self._Entity.NastranLoadId
 841
 842	@property
 843	def NastranSpcId(self) -> int:
 844		return self._Entity.NastranSpcId
 845
 846	@property
 847	def AbaqusStepName(self) -> str:
 848		return self._Entity.AbaqusStepName
 849
 850	@property
 851	def AbaqusLoadCaseName(self) -> str:
 852		return self._Entity.AbaqusLoadCaseName
 853
 854	@property
 855	def AbaqusStepTime(self) -> float:
 856		return self._Entity.AbaqusStepTime
 857
 858	@property
 859	def RunDeckOrder(self) -> int:
 860		return self._Entity.RunDeckOrder
 861
 862	@property
 863	def SolutionType(self) -> types.FeaSolutionType:
 864		return types.FeaSolutionType[self._Entity.SolutionType.ToString()]
 865
 866
 867class DesignLoadSubcaseMultiplier(IdNameEntity):
 868	def __init__(self, designLoadSubcaseMultiplier: _api.DesignLoadSubcaseMultiplier):
 869		self._Entity = designLoadSubcaseMultiplier
 870
 871	@property
 872	def LimitFactor(self) -> float:
 873		return self._Entity.LimitFactor
 874
 875	@property
 876	def Subcase(self) -> DesignLoadSubcase:
 877		result = self._Entity.Subcase
 878		return DesignLoadSubcase(result) if result is not None else None
 879
 880	@property
 881	def UltimateFactor(self) -> float:
 882		return self._Entity.UltimateFactor
 883
 884	@property
 885	def Value(self) -> float:
 886		return self._Entity.Value
 887
 888
 889class DesignLoadSubcaseTemperature(IdNameEntity):
 890	def __init__(self, designLoadSubcaseTemperature: _api.DesignLoadSubcaseTemperature):
 891		self._Entity = designLoadSubcaseTemperature
 892
 893	@property
 894	def HasTemperatureSubcase(self) -> bool:
 895		return self._Entity.HasTemperatureSubcase
 896
 897	@property
 898	def Subcase(self) -> DesignLoadSubcase:
 899		result = self._Entity.Subcase
 900		return DesignLoadSubcase(result) if result is not None else None
 901
 902	@property
 903	def TemperatureChoiceType(self) -> types.TemperatureChoiceType:
 904		'''
 905		Load Case Setting selection for analysis and initial temperature.
 906		'''
 907		return types.TemperatureChoiceType[self._Entity.TemperatureChoiceType.ToString()]
 908
 909	@property
 910	def Value(self) -> float:
 911		return self._Entity.Value
 912
 913
 914class DesignLoadSubcaseMultiplierCol(IdNameEntityCol[DesignLoadSubcaseMultiplier]):
 915	def __init__(self, designLoadSubcaseMultiplierCol: _api.DesignLoadSubcaseMultiplierCol):
 916		self._Entity = designLoadSubcaseMultiplierCol
 917		self._CollectedClass = DesignLoadSubcaseMultiplier
 918
 919	@property
 920	def DesignLoadSubcaseMultiplierColList(self) -> tuple[DesignLoadSubcaseMultiplier]:
 921		return tuple([DesignLoadSubcaseMultiplier(designLoadSubcaseMultiplierCol) for designLoadSubcaseMultiplierCol in self._Entity])
 922
 923	@overload
 924	def Get(self, name: str) -> DesignLoadSubcaseMultiplier: ...
 925
 926	@overload
 927	def Get(self, id: int) -> DesignLoadSubcaseMultiplier: ...
 928
 929	def Get(self, item1 = None) -> DesignLoadSubcaseMultiplier:
 930		if isinstance(item1, str):
 931			return DesignLoadSubcaseMultiplier(super().Get(item1))
 932
 933		if isinstance(item1, int):
 934			return DesignLoadSubcaseMultiplier(super().Get(item1))
 935
 936		return DesignLoadSubcaseMultiplier(self._Entity.Get(item1))
 937
 938	def __getitem__(self, index: int):
 939		return self.DesignLoadSubcaseMultiplierColList[index]
 940
 941	def __iter__(self):
 942		yield from self.DesignLoadSubcaseMultiplierColList
 943
 944	def __len__(self):
 945		return len(self.DesignLoadSubcaseMultiplierColList)
 946
 947
 948class DesignLoad(IdNameEntity):
 949	def __init__(self, designLoad: _api.DesignLoad):
 950		self._Entity = designLoad
 951
 952	@property
 953	def AnalysisTemperature(self) -> DesignLoadSubcaseTemperature:
 954		result = self._Entity.AnalysisTemperature
 955		return DesignLoadSubcaseTemperature(result) if result is not None else None
 956
 957	@property
 958	def InitialTemperature(self) -> DesignLoadSubcaseTemperature:
 959		result = self._Entity.InitialTemperature
 960		return DesignLoadSubcaseTemperature(result) if result is not None else None
 961
 962	@property
 963	def Description(self) -> str:
 964		return self._Entity.Description
 965
 966	@property
 967	def IsActive(self) -> bool:
 968		return self._Entity.IsActive
 969
 970	@property
 971	def IsEditable(self) -> bool:
 972		return self._Entity.IsEditable
 973
 974	@property
 975	def IsVirtual(self) -> bool:
 976		return self._Entity.IsVirtual
 977
 978	@property
 979	def ModificationDate(self) -> DateTime:
 980		return self._Entity.ModificationDate
 981
 982	@property
 983	def SubcaseMultipliers(self) -> DesignLoadSubcaseMultiplierCol:
 984		result = self._Entity.SubcaseMultipliers
 985		return DesignLoadSubcaseMultiplierCol(result) if result is not None else None
 986
 987	@property
 988	def Types(self) -> list[types.LoadCaseType]:
 989		return [types.LoadCaseType[loadCaseType.ToString()] for loadCaseType in self._Entity.Types]
 990
 991	@property
 992	def UID(self) -> Guid:
 993		return self._Entity.UID
 994
 995
 996class JointDesignResult(IdEntity):
 997	def __init__(self, jointDesignResult: _api.JointDesignResult):
 998		self._Entity = jointDesignResult
 999
1000
1001class ZoneDesignResult(IdEntity):
1002	def __init__(self, zoneDesignResult: _api.ZoneDesignResult):
1003		self._Entity = zoneDesignResult
1004
1005	@property
1006	def VariableParameter(self) -> types.VariableParameter:
1007		return types.VariableParameter[self._Entity.VariableParameter.ToString()]
1008
1009	@property
1010	def Value(self) -> float:
1011		return self._Entity.Value
1012
1013	@property
1014	def MaterialId(self) -> int:
1015		return self._Entity.MaterialId
1016
1017	@property
1018	def MaterialType(self) -> types.MaterialType:
1019		return types.MaterialType[self._Entity.MaterialType.ToString()]
1020
1021
1022class Vector3d:
1023	'''
1024	Represents a readonly 3D vector.
1025	'''
1026	def __init__(self, vector3d: _api.Vector3d):
1027		self._Entity = vector3d
1028
1029	def Create_Vector3d(x: float, y: float, z: float):
1030		return Vector3d(_api.Vector3d(x, y, z))
1031
1032	@property
1033	def X(self) -> float:
1034		return self._Entity.X
1035
1036	@property
1037	def Y(self) -> float:
1038		return self._Entity.Y
1039
1040	@property
1041	def Z(self) -> float:
1042		return self._Entity.Z
1043
1044	@overload
1045	def Equals(self, other) -> bool: ...
1046
1047	@overload
1048	def Equals(self, obj) -> bool: ...
1049
1050	def GetHashCode(self) -> int:
1051		return self._Entity.GetHashCode()
1052
1053	def Equals(self, item1 = None) -> bool:
1054		if isinstance(item1, Vector3d):
1055			return self._Entity.Equals(item1._Entity)
1056
1057		return self._Entity.Equals(item1._Entity)
1058
1059	def __eq__(self, other):
1060		return self.Equals(other)
1061
1062	def __ne__(self, other):
1063		return not self.Equals(other)
1064
1065
1066class DiscreteField(IdNameEntityRenameable):
1067	'''
1068	Represents a table of discrete field data.
1069	'''
1070	def __init__(self, discreteField: _api.DiscreteField):
1071		self._Entity = discreteField
1072
1073	@property
1074	def Columns(self) -> dict[int, str]:
1075		columnsDict = {}
1076		for kvp in self._Entity.Columns:
1077			columnsDict[int(kvp.Key)] = str(kvp.Value)
1078
1079		return columnsDict
1080
1081	@property
1082	def ColumnCount(self) -> int:
1083		return self._Entity.ColumnCount
1084
1085	@property
1086	def DataType(self) -> types.DiscreteFieldDataType:
1087		'''
1088		Defines the type of data stored in a Discrete Field. Such as Vector, Scalar, String.
1089		'''
1090		return types.DiscreteFieldDataType[self._Entity.DataType.ToString()]
1091
1092	@property
1093	def PhysicalEntityType(self) -> types.DiscreteFieldPhysicalEntityType:
1094		'''
1095		Defines the type of physical entity that a Discrete Field applies to, such as zone, element, joint, etc.
1096		'''
1097		return types.DiscreteFieldPhysicalEntityType[self._Entity.PhysicalEntityType.ToString()]
1098
1099	@property
1100	def PointIds(self) -> list[Vector3d]:
1101		return [Vector3d(vector3d) for vector3d in self._Entity.PointIds]
1102
1103	@property
1104	def RowCount(self) -> int:
1105		return self._Entity.RowCount
1106
1107	@property
1108	def RowIds(self) -> list[int]:
1109		return [int32 for int32 in self._Entity.RowIds]
1110
1111	def AddColumn(self, name: str) -> int:
1112		return self._Entity.AddColumn(name)
1113
1114	def AddPointRow(self, pointId: Vector3d) -> None:
1115		return self._Entity.AddPointRow(pointId._Entity)
1116
1117	@overload
1118	def ReadNumericCell(self, entityId: int, columnId: int) -> float: ...
1119
1120	@overload
1121	def ReadNumericCell(self, pointId: Vector3d, columnId: int) -> float: ...
1122
1123	@overload
1124	def ReadStringCell(self, entityId: int, columnId: int) -> str: ...
1125
1126	@overload
1127	def ReadStringCell(self, pointId: Vector3d, columnId: int) -> str: ...
1128
1129	def SetColumnName(self, columnId: int, name: str) -> None:
1130		return self._Entity.SetColumnName(columnId, name)
1131
1132	@overload
1133	def SetNumericValue(self, entityId: int, columnId: int, value: float) -> None: ...
1134
1135	@overload
1136	def SetNumericValue(self, pointId: Vector3d, columnId: int, value: float) -> None: ...
1137
1138	@overload
1139	def SetStringValue(self, entityId: int, columnId: int, value: str) -> None: ...
1140
1141	@overload
1142	def SetStringValue(self, pointId: Vector3d, columnId: int, value: str) -> None: ...
1143
1144	def DeleteAllRows(self) -> None:
1145		'''
1146		Delete all rows for this discrete field.
1147		'''
1148		return self._Entity.DeleteAllRows()
1149
1150	def DeleteColumn(self, columnId: int) -> None:
1151		return self._Entity.DeleteColumn(columnId)
1152
1153	def DeletePointRow(self, pointId: Vector3d) -> None:
1154		return self._Entity.DeletePointRow(pointId._Entity)
1155
1156	def DeleteRow(self, entityId: int) -> None:
1157		return self._Entity.DeleteRow(entityId)
1158
1159	def DeleteRowsAndColumns(self) -> None:
1160		'''
1161		Delete all rows and columns for this discrete field.
1162		'''
1163		return self._Entity.DeleteRowsAndColumns()
1164
1165	def ReadNumericCell(self, item1 = None, item2 = None) -> float:
1166		if isinstance(item1, int) and isinstance(item2, int):
1167			return self._Entity.ReadNumericCell(item1, item2)
1168
1169		if isinstance(item1, Vector3d) and isinstance(item2, int):
1170			return self._Entity.ReadNumericCell(item1._Entity, item2)
1171
1172		return self._Entity.ReadNumericCell(item1, item2)
1173
1174	def ReadStringCell(self, item1 = None, item2 = None) -> str:
1175		if isinstance(item1, int) and isinstance(item2, int):
1176			return self._Entity.ReadStringCell(item1, item2)
1177
1178		if isinstance(item1, Vector3d) and isinstance(item2, int):
1179			return self._Entity.ReadStringCell(item1._Entity, item2)
1180
1181		return self._Entity.ReadStringCell(item1, item2)
1182
1183	def SetNumericValue(self, item1 = None, item2 = None, item3 = None) -> None:
1184		if isinstance(item1, int) and isinstance(item2, int) and isinstance(item3, float):
1185			return self._Entity.SetNumericValue(item1, item2, item3)
1186
1187		if isinstance(item1, Vector3d) and isinstance(item2, int) and isinstance(item3, float):
1188			return self._Entity.SetNumericValue(item1._Entity, item2, item3)
1189
1190		return self._Entity.SetNumericValue(item1, item2, item3)
1191
1192	def SetStringValue(self, item1 = None, item2 = None, item3 = None) -> None:
1193		if isinstance(item1, int) and isinstance(item2, int) and isinstance(item3, str):
1194			return self._Entity.SetStringValue(item1, item2, item3)
1195
1196		if isinstance(item1, Vector3d) and isinstance(item2, int) and isinstance(item3, str):
1197			return self._Entity.SetStringValue(item1._Entity, item2, item3)
1198
1199		return self._Entity.SetStringValue(item1, item2, item3)
1200
1201
1202class Node(IdEntity):
1203	def __init__(self, node: _api.Node):
1204		self._Entity = node
1205
1206	@property
1207	def X(self) -> float:
1208		return self._Entity.X
1209
1210	@property
1211	def Y(self) -> float:
1212		return self._Entity.Y
1213
1214	@property
1215	def Z(self) -> float:
1216		return self._Entity.Z
1217
1218
1219class Centroid:
1220	def __init__(self, centroid: _api.Centroid):
1221		self._Entity = centroid
1222
1223	@property
1224	def X(self) -> float:
1225		return self._Entity.X
1226
1227	@property
1228	def Y(self) -> float:
1229		return self._Entity.Y
1230
1231	@property
1232	def Z(self) -> float:
1233		return self._Entity.Z
1234
1235
1236class Element(IdEntity):
1237	def __init__(self, element: _api.Element):
1238		self._Entity = element
1239
1240	@property
1241	def MarginOfSafety(self) -> float:
1242		return self._Entity.MarginOfSafety
1243
1244	@property
1245	def Centroid(self) -> Centroid:
1246		result = self._Entity.Centroid
1247		return Centroid(result) if result is not None else None
1248
1249	@property
1250	def Nodes(self) -> list[Node]:
1251		return [Node(node) for node in self._Entity.Nodes]
1252
1253
1254class FailureModeCategory(IdNameEntity):
1255	def __init__(self, failureModeCategory: _api.FailureModeCategory):
1256		self._Entity = failureModeCategory
1257
1258	@property
1259	def PackageId(self) -> int:
1260		return self._Entity.PackageId
1261
1262
1263class EntityWithAssignableProperties(IdNameEntityRenameable):
1264	def __init__(self, entityWithAssignableProperties: _api.EntityWithAssignableProperties):
1265		self._Entity = entityWithAssignableProperties
1266
1267	@property
1268	def AssignedAnalysisProperty(self) -> AnalysisProperty:
1269		result = self._Entity.AssignedAnalysisProperty
1270		return AnalysisProperty(result) if result is not None else None
1271
1272	@property
1273	def AssignedDesignProperty(self) -> DesignProperty:
1274		thisClass = type(self._Entity.AssignedDesignProperty).__name__
1275		givenClass = DesignProperty
1276		for subclass in DesignProperty.__subclasses__():
1277			if subclass.__name__ == thisClass:
1278				givenClass = subclass
1279		result = self._Entity.AssignedDesignProperty
1280		return givenClass(result) if result is not None else None
1281
1282	@property
1283	def AssignedLoadProperty(self) -> LoadProperty:
1284		thisClass = type(self._Entity.AssignedLoadProperty).__name__
1285		givenClass = LoadProperty
1286		for subclass in LoadProperty.__subclasses__():
1287			if subclass.__name__ == thisClass:
1288				givenClass = subclass
1289		result = self._Entity.AssignedLoadProperty
1290		return givenClass(result) if result is not None else None
1291
1292	def AssignAnalysisProperty(self, id: int) -> PropertyAssignmentStatus:
1293		return PropertyAssignmentStatus[self._Entity.AssignAnalysisProperty(id).ToString()]
1294
1295	def AssignDesignProperty(self, id: int) -> PropertyAssignmentStatus:
1296		return PropertyAssignmentStatus[self._Entity.AssignDesignProperty(id).ToString()]
1297
1298	def AssignLoadProperty(self, id: int) -> PropertyAssignmentStatus:
1299		return PropertyAssignmentStatus[self._Entity.AssignLoadProperty(id).ToString()]
1300
1301	def AssignProperty(self, property: AssignableProperty) -> PropertyAssignmentStatus:
1302		return PropertyAssignmentStatus[self._Entity.AssignProperty(property._Entity).ToString()]
1303
1304
1305class AnalysisResultCol(Generic[T]):
1306	def __init__(self, analysisResultCol: _api.AnalysisResultCol):
1307		self._Entity = analysisResultCol
1308
1309	@property
1310	def AnalysisResultColList(self) -> tuple[AnalysisResult]:
1311		if self._Entity.Count() <= 0:
1312			return ()
1313		thisClass = type(self._Entity._items[0]).__name__
1314		givenClass = AnalysisResult
1315		for subclass in AnalysisResult.__subclasses__():
1316			if subclass.__name__ == thisClass:
1317				givenClass = subclass
1318		return tuple([givenClass(analysisResultCol) for analysisResultCol in self._Entity])
1319
1320	def Count(self) -> int:
1321		return self._Entity.Count()
1322
1323	def __getitem__(self, index: int):
1324		return self.AnalysisResultColList[index]
1325
1326	def __iter__(self):
1327		yield from self.AnalysisResultColList
1328
1329	def __len__(self):
1330		return len(self.AnalysisResultColList)
1331
1332
1333class ZoneJointEntity(EntityWithAssignableProperties):
1334	'''
1335	Abstract base for a Zone or Joint.
1336	'''
1337	def __init__(self, zoneJointEntity: _api.ZoneJointEntity):
1338		self._Entity = zoneJointEntity
1339
1340	@abstractmethod
1341	def GetMinimumMargin(self) -> Margin:
1342		return Margin(self._Entity.GetMinimumMargin())
1343
1344	@abstractmethod
1345	def GetControllingResult(self) -> AnalysisResult:
1346		result = self._Entity.GetControllingResult()
1347		thisClass = type(result).__name__
1348		givenClass = AnalysisResult
1349		for subclass in AnalysisResult.__subclasses__():
1350			if subclass.__name__ == thisClass:
1351				givenClass = subclass
1352		return givenClass(result)
1353
1354	@abstractmethod
1355	def GetAllResults(self) -> AnalysisResultCol:
1356		return AnalysisResultCol(self._Entity.GetAllResults())
1357
1358
1359class JointDesignResultCol(IdEntityCol[JointDesignResult]):
1360	def __init__(self, jointDesignResultCol: _api.JointDesignResultCol):
1361		self._Entity = jointDesignResultCol
1362		self._CollectedClass = JointDesignResult
1363
1364	@property
1365	def JointDesignResultColList(self) -> tuple[JointDesignResult]:
1366		return tuple([JointDesignResult(jointDesignResultCol) for jointDesignResultCol in self._Entity])
1367
1368	@overload
1369	def Get(self, jointSelectionId: types.JointSelectionId) -> JointDesignResult: ...
1370
1371	@overload
1372	def Get(self, jointRangeId: types.JointRangeId) -> JointDesignResult: ...
1373
1374	@overload
1375	def Get(self, id: int) -> JointDesignResult: ...
1376
1377	def Get(self, item1 = None) -> JointDesignResult:
1378		if isinstance(item1, types.JointSelectionId):
1379			result = self._Entity.Get(_types.JointSelectionId(item1.value))
1380			thisClass = type(result).__name__
1381			givenClass = JointDesignResult
1382			for subclass in JointDesignResult.__subclasses__():
1383				if subclass.__name__ == thisClass:
1384					givenClass = subclass
1385			return givenClass(result)
1386
1387		if isinstance(item1, types.JointRangeId):
1388			result = self._Entity.Get(_types.JointRangeId(item1.value))
1389			thisClass = type(result).__name__
1390			givenClass = JointDesignResult
1391			for subclass in JointDesignResult.__subclasses__():
1392				if subclass.__name__ == thisClass:
1393					givenClass = subclass
1394			return givenClass(result)
1395
1396		if isinstance(item1, int):
1397			return JointDesignResult(super().Get(item1))
1398
1399		result = self._Entity.Get(_types.JointSelectionId(item1.value))
1400		thisClass = type(result).__name__
1401		givenClass = JointDesignResult
1402		for subclass in JointDesignResult.__subclasses__():
1403			if subclass.__name__ == thisClass:
1404				givenClass = subclass
1405		return givenClass(result)
1406
1407	def __getitem__(self, index: int):
1408		return self.JointDesignResultColList[index]
1409
1410	def __iter__(self):
1411		yield from self.JointDesignResultColList
1412
1413	def __len__(self):
1414		return len(self.JointDesignResultColList)
1415
1416
1417class Joint(ZoneJointEntity):
1418	def __init__(self, joint: _api.Joint):
1419		self._Entity = joint
1420
1421	@property
1422	def JointRangeSizingResults(self) -> JointDesignResultCol:
1423		result = self._Entity.JointRangeSizingResults
1424		return JointDesignResultCol(result) if result is not None else None
1425
1426	@property
1427	def JointSelectionSizingResults(self) -> JointDesignResultCol:
1428		result = self._Entity.JointSelectionSizingResults
1429		return JointDesignResultCol(result) if result is not None else None
1430
1431	def GetAllResults(self) -> AnalysisResultCol:
1432		return AnalysisResultCol(self._Entity.GetAllResults())
1433
1434	def GetControllingResult(self) -> AnalysisResult:
1435		result = self._Entity.GetControllingResult()
1436		thisClass = type(result).__name__
1437		givenClass = AnalysisResult
1438		for subclass in AnalysisResult.__subclasses__():
1439			if subclass.__name__ == thisClass:
1440				givenClass = subclass
1441		return givenClass(result)
1442
1443	def GetMinimumMargin(self) -> Margin:
1444		return Margin(self._Entity.GetMinimumMargin())
1445
1446
1447class ZoneDesignResultCol(IdEntityCol[ZoneDesignResult]):
1448	def __init__(self, zoneDesignResultCol: _api.ZoneDesignResultCol):
1449		self._Entity = zoneDesignResultCol
1450		self._CollectedClass = ZoneDesignResult
1451
1452	@property
1453	def ZoneDesignResultColList(self) -> tuple[ZoneDesignResult]:
1454		return tuple([ZoneDesignResult(zoneDesignResultCol) for zoneDesignResultCol in self._Entity])
1455
1456	@overload
1457	def Get(self, parameterId: types.VariableParameter) -> ZoneDesignResult: ...
1458
1459	@overload
1460	def Get(self, id: int) -> ZoneDesignResult: ...
1461
1462	def Get(self, item1 = None) -> ZoneDesignResult:
1463		if isinstance(item1, types.VariableParameter):
1464			return ZoneDesignResult(self._Entity.Get(_types.VariableParameter(item1.value)))
1465
1466		if isinstance(item1, int):
1467			return ZoneDesignResult(super().Get(item1))
1468
1469		return ZoneDesignResult(self._Entity.Get(_types.VariableParameter(item1.value)))
1470
1471	def __getitem__(self, index: int):
1472		return self.ZoneDesignResultColList[index]
1473
1474	def __iter__(self):
1475		yield from self.ZoneDesignResultColList
1476
1477	def __len__(self):
1478		return len(self.ZoneDesignResultColList)
1479
1480
1481class ZoneBase(ZoneJointEntity):
1482	'''
1483	Abstract for regular Zones and Panel Segments.
1484	'''
1485	def __init__(self, zoneBase: _api.ZoneBase):
1486		self._Entity = zoneBase
1487
1488	@property
1489	def Centroid(self) -> Centroid:
1490		result = self._Entity.Centroid
1491		return Centroid(result) if result is not None else None
1492
1493	@property
1494	def Id(self) -> int:
1495		return self._Entity.Id
1496
1497	@property
1498	def Weight(self) -> float:
1499		return self._Entity.Weight
1500
1501	@property
1502	def NonOptimumFactor(self) -> float:
1503		return self._Entity.NonOptimumFactor
1504
1505	@property
1506	def AddedWeight(self) -> float:
1507		return self._Entity.AddedWeight
1508
1509	@property
1510	def SuperimposePanel(self) -> bool:
1511		return self._Entity.SuperimposePanel
1512
1513	@property
1514	def BucklingImperfection(self) -> float:
1515		return self._Entity.BucklingImperfection
1516
1517	@property
1518	def IsBeamColumn(self) -> bool:
1519		return self._Entity.IsBeamColumn
1520
1521	@property
1522	def SuperimposeBoundaryCondition(self) -> int:
1523		return self._Entity.SuperimposeBoundaryCondition
1524
1525	@property
1526	def IsZeroOutFeaMoments(self) -> bool:
1527		return self._Entity.IsZeroOutFeaMoments
1528
1529	@property
1530	def IsZeroOutFeaTransverseShears(self) -> bool:
1531		return self._Entity.IsZeroOutFeaTransverseShears
1532
1533	@property
1534	def MechanicalLimit(self) -> float:
1535		return self._Entity.MechanicalLimit
1536
1537	@property
1538	def MechanicalUltimate(self) -> float:
1539		return self._Entity.MechanicalUltimate
1540
1541	@property
1542	def ThermalHelp(self) -> float:
1543		return self._Entity.ThermalHelp
1544
1545	@property
1546	def ThermalHurt(self) -> float:
1547		return self._Entity.ThermalHurt
1548
1549	@property
1550	def FatigueKTSkin(self) -> float:
1551		return self._Entity.FatigueKTSkin
1552
1553	@property
1554	def FatigueKTStiff(self) -> float:
1555		return self._Entity.FatigueKTStiff
1556
1557	@property
1558	def XSpan(self) -> float:
1559		return self._Entity.XSpan
1560
1561	@property
1562	def EARequired(self) -> float:
1563		return self._Entity.EARequired
1564
1565	@property
1566	def EI1Required(self) -> float:
1567		return self._Entity.EI1Required
1568
1569	@property
1570	def EI2Required(self) -> float:
1571		return self._Entity.EI2Required
1572
1573	@property
1574	def GJRequired(self) -> float:
1575		return self._Entity.GJRequired
1576
1577	@property
1578	def EAAuto(self) -> float:
1579		return self._Entity.EAAuto
1580
1581	@property
1582	def EI1Auto(self) -> float:
1583		return self._Entity.EI1Auto
1584
1585	@property
1586	def EI2Auto(self) -> float:
1587		return self._Entity.EI2Auto
1588
1589	@property
1590	def GJAuto(self) -> float:
1591		return self._Entity.GJAuto
1592
1593	@property
1594	def Ex(self) -> float:
1595		return self._Entity.Ex
1596
1597	@property
1598	def Dmid(self) -> float:
1599		return self._Entity.Dmid
1600
1601	@NonOptimumFactor.setter
1602	def NonOptimumFactor(self, value: float) -> None:
1603		self._Entity.NonOptimumFactor = value
1604
1605	@AddedWeight.setter
1606	def AddedWeight(self, value: float) -> None:
1607		self._Entity.AddedWeight = value
1608
1609	@SuperimposePanel.setter
1610	def SuperimposePanel(self, value: bool) -> None:
1611		self._Entity.SuperimposePanel = value
1612
1613	@BucklingImperfection.setter
1614	def BucklingImperfection(self, value: float) -> None:
1615		self._Entity.BucklingImperfection = value
1616
1617	@IsBeamColumn.setter
1618	def IsBeamColumn(self, value: bool) -> None:
1619		self._Entity.IsBeamColumn = value
1620
1621	@SuperimposeBoundaryCondition.setter
1622	def SuperimposeBoundaryCondition(self, value: int) -> None:
1623		self._Entity.SuperimposeBoundaryCondition = value
1624
1625	@IsZeroOutFeaMoments.setter
1626	def IsZeroOutFeaMoments(self, value: bool) -> None:
1627		self._Entity.IsZeroOutFeaMoments = value
1628
1629	@IsZeroOutFeaTransverseShears.setter
1630	def IsZeroOutFeaTransverseShears(self, value: bool) -> None:
1631		self._Entity.IsZeroOutFeaTransverseShears = value
1632
1633	@MechanicalLimit.setter
1634	def MechanicalLimit(self, value: float) -> None:
1635		self._Entity.MechanicalLimit = value
1636
1637	@MechanicalUltimate.setter
1638	def MechanicalUltimate(self, value: float) -> None:
1639		self._Entity.MechanicalUltimate = value
1640
1641	@ThermalHelp.setter
1642	def ThermalHelp(self, value: float) -> None:
1643		self._Entity.ThermalHelp = value
1644
1645	@ThermalHurt.setter
1646	def ThermalHurt(self, value: float) -> None:
1647		self._Entity.ThermalHurt = value
1648
1649	@FatigueKTSkin.setter
1650	def FatigueKTSkin(self, value: float) -> None:
1651		self._Entity.FatigueKTSkin = value
1652
1653	@FatigueKTStiff.setter
1654	def FatigueKTStiff(self, value: float) -> None:
1655		self._Entity.FatigueKTStiff = value
1656
1657	@XSpan.setter
1658	def XSpan(self, value: float) -> None:
1659		self._Entity.XSpan = value
1660
1661	@EARequired.setter
1662	def EARequired(self, value: float) -> None:
1663		self._Entity.EARequired = value
1664
1665	@EI1Required.setter
1666	def EI1Required(self, value: float) -> None:
1667		self._Entity.EI1Required = value
1668
1669	@EI2Required.setter
1670	def EI2Required(self, value: float) -> None:
1671		self._Entity.EI2Required = value
1672
1673	@GJRequired.setter
1674	def GJRequired(self, value: float) -> None:
1675		self._Entity.GJRequired = value
1676
1677	@Ex.setter
1678	def Ex(self, value: float) -> None:
1679		self._Entity.Ex = value
1680
1681	@Dmid.setter
1682	def Dmid(self, value: float) -> None:
1683		self._Entity.Dmid = value
1684
1685	def GetObjectName(self, objectId: types.FamilyObjectUID) -> str:
1686		return self._Entity.GetObjectName(_types.FamilyObjectUID(objectId.value))
1687
1688	def GetConceptName(self) -> str:
1689		return self._Entity.GetConceptName()
1690
1691	def GetZoneDesignResults(self, solutionId: int = 1) -> ZoneDesignResultCol:
1692		return ZoneDesignResultCol(self._Entity.GetZoneDesignResults(solutionId))
1693
1694	def RenumberZone(self, newId: int) -> ZoneIdUpdateStatus:
1695		return ZoneIdUpdateStatus[self._Entity.RenumberZone(newId).ToString()]
1696
1697	def GetAllResults(self) -> AnalysisResultCol:
1698		return AnalysisResultCol(self._Entity.GetAllResults())
1699
1700	def GetControllingResult(self) -> AnalysisResult:
1701		result = self._Entity.GetControllingResult()
1702		thisClass = type(result).__name__
1703		givenClass = AnalysisResult
1704		for subclass in AnalysisResult.__subclasses__():
1705			if subclass.__name__ == thisClass:
1706				givenClass = subclass
1707		return givenClass(result)
1708
1709	def GetMinimumMargin(self) -> Margin:
1710		return Margin(self._Entity.GetMinimumMargin())
1711
1712
1713class ElementCol(IdEntityCol[Element]):
1714	def __init__(self, elementCol: _api.ElementCol):
1715		self._Entity = elementCol
1716		self._CollectedClass = Element
1717
1718	@property
1719	def ElementColList(self) -> tuple[Element]:
1720		return tuple([Element(elementCol) for elementCol in self._Entity])
1721
1722	def __getitem__(self, index: int):
1723		return self.ElementColList[index]
1724
1725	def __iter__(self):
1726		yield from self.ElementColList
1727
1728	def __len__(self):
1729		return len(self.ElementColList)
1730
1731
1732class PanelSegment(ZoneBase):
1733	def __init__(self, panelSegment: _api.PanelSegment):
1734		self._Entity = panelSegment
1735
1736	@property
1737	def ElementsByObjectOrSkin(self) -> dict[types.DiscreteDefinitionType, ElementCol]:
1738		elementsByObjectOrSkinDict = {}
1739		for kvp in self._Entity.ElementsByObjectOrSkin:
1740			elementsByObjectOrSkinDict[types.DiscreteDefinitionType[kvp.Key.ToString()]] = ElementCol(kvp.Value)
1741
1742		return elementsByObjectOrSkinDict
1743
1744	@property
1745	def Skins(self) -> tuple[types.DiscreteDefinitionType]:
1746		return tuple([types.DiscreteDefinitionType(discreteDefinitionType) for discreteDefinitionType in self._Entity.Skins])
1747
1748	@property
1749	def Objects(self) -> tuple[types.DiscreteDefinitionType]:
1750		return tuple([types.DiscreteDefinitionType(discreteDefinitionType) for discreteDefinitionType in self._Entity.Objects])
1751
1752	@property
1753	def DiscreteTechnique(self) -> types.DiscreteTechnique:
1754		return types.DiscreteTechnique[self._Entity.DiscreteTechnique.ToString()]
1755
1756	@property
1757	def LeftSkinZoneId(self) -> int:
1758		return self._Entity.LeftSkinZoneId
1759
1760	@property
1761	def RightSkinZoneId(self) -> int:
1762		return self._Entity.RightSkinZoneId
1763
1764	def GetElements(self, discreteDefinitionType: types.DiscreteDefinitionType) -> ElementCol:
1765		return ElementCol(self._Entity.GetElements(_types.DiscreteDefinitionType(discreteDefinitionType.value)))
1766
1767	def SetObjectElements(self, discreteDefinitionType: types.DiscreteDefinitionType, elementIds: tuple[int]) -> None:
1768		elementIdsList = MakeCSharpIntList(elementIds)
1769		elementIdsEnumerable = IEnumerable(elementIdsList)
1770		return self._Entity.SetObjectElements(_types.DiscreteDefinitionType(discreteDefinitionType.value), elementIdsEnumerable)
1771
1772
1773class Zone(ZoneBase):
1774	'''
1775	Abstract for regular Zones (not Panel Segments).
1776	'''
1777	def __init__(self, zone: _api.Zone):
1778		self._Entity = zone
1779
1780	@property
1781	def Elements(self) -> ElementCol:
1782		result = self._Entity.Elements
1783		return ElementCol(result) if result is not None else None
1784
1785	def AddElements(self, elementIds: tuple[int]) -> None:
1786		elementIdsList = MakeCSharpIntList(elementIds)
1787		elementIdsEnumerable = IEnumerable(elementIdsList)
1788		return self._Entity.AddElements(elementIdsEnumerable)
1789
1790
1791class EntityWithAssignablePropertiesCol(IdNameEntityCol, Generic[T]):
1792	def __init__(self, entityWithAssignablePropertiesCol: _api.EntityWithAssignablePropertiesCol):
1793		self._Entity = entityWithAssignablePropertiesCol
1794		self._CollectedClass = T
1795
1796	@property
1797	def EntityWithAssignablePropertiesColList(self) -> tuple[T]:
1798		if self._Entity.Count() <= 0:
1799			return ()
1800		thisClass = type(self._Entity._items[0]).__name__
1801		givenClass = T
1802		for subclass in T.__subclasses__():
1803			if subclass.__name__ == thisClass:
1804				givenClass = subclass
1805		return tuple([givenClass(entityWithAssignablePropertiesCol) for entityWithAssignablePropertiesCol in self._Entity])
1806
1807	def AssignPropertyToAll(self, property: AssignableProperty) -> PropertyAssignmentStatus:
1808		return PropertyAssignmentStatus[self._Entity.AssignPropertyToAll(property._Entity).ToString()]
1809
1810	@overload
1811	def Get(self, name: str) -> T: ...
1812
1813	@overload
1814	def Get(self, id: int) -> T: ...
1815
1816	def Get(self, item1 = None) -> T:
1817		if isinstance(item1, str):
1818			return super().Get(item1)
1819
1820		if isinstance(item1, int):
1821			return super().Get(item1)
1822
1823		return self._Entity.Get(item1)
1824
1825	def __getitem__(self, index: int):
1826		return self.EntityWithAssignablePropertiesColList[index]
1827
1828	def __iter__(self):
1829		yield from self.EntityWithAssignablePropertiesColList
1830
1831	def __len__(self):
1832		return len(self.EntityWithAssignablePropertiesColList)
1833
1834
1835class JointCol(EntityWithAssignablePropertiesCol[Joint]):
1836	def __init__(self, jointCol: _api.JointCol):
1837		self._Entity = jointCol
1838		self._CollectedClass = Joint
1839
1840	@property
1841	def JointColList(self) -> tuple[Joint]:
1842		return tuple([Joint(jointCol) for jointCol in self._Entity])
1843
1844	@overload
1845	def Get(self, name: str) -> Joint: ...
1846
1847	@overload
1848	def Get(self, id: int) -> Joint: ...
1849
1850	def Get(self, item1 = None) -> Joint:
1851		if isinstance(item1, str):
1852			return Joint(super().Get(item1))
1853
1854		if isinstance(item1, int):
1855			return Joint(super().Get(item1))
1856
1857		return Joint(self._Entity.Get(item1))
1858
1859	def __getitem__(self, index: int):
1860		return self.JointColList[index]
1861
1862	def __iter__(self):
1863		yield from self.JointColList
1864
1865	def __len__(self):
1866		return len(self.JointColList)
1867
1868
1869class PanelSegmentCol(EntityWithAssignablePropertiesCol[PanelSegment]):
1870	def __init__(self, panelSegmentCol: _api.PanelSegmentCol):
1871		self._Entity = panelSegmentCol
1872		self._CollectedClass = PanelSegment
1873
1874	@property
1875	def PanelSegmentColList(self) -> tuple[PanelSegment]:
1876		return tuple([PanelSegment(panelSegmentCol) for panelSegmentCol in self._Entity])
1877
1878	@overload
1879	def Get(self, name: str) -> PanelSegment: ...
1880
1881	@overload
1882	def Get(self, id: int) -> PanelSegment: ...
1883
1884	def Get(self, item1 = None) -> PanelSegment:
1885		if isinstance(item1, str):
1886			return PanelSegment(super().Get(item1))
1887
1888		if isinstance(item1, int):
1889			return PanelSegment(super().Get(item1))
1890
1891		return PanelSegment(self._Entity.Get(item1))
1892
1893	def __getitem__(self, index: int):
1894		return self.PanelSegmentColList[index]
1895
1896	def __iter__(self):
1897		yield from self.PanelSegmentColList
1898
1899	def __len__(self):
1900		return len(self.PanelSegmentColList)
1901
1902
1903class ZoneCol(EntityWithAssignablePropertiesCol[Zone]):
1904	def __init__(self, zoneCol: _api.ZoneCol):
1905		self._Entity = zoneCol
1906		self._CollectedClass = Zone
1907
1908	@property
1909	def ZoneColList(self) -> tuple[Zone]:
1910		return tuple([Zone(zoneCol) for zoneCol in self._Entity])
1911
1912	@overload
1913	def Get(self, name: str) -> Zone: ...
1914
1915	@overload
1916	def Get(self, id: int) -> Zone: ...
1917
1918	def Get(self, item1 = None) -> Zone:
1919		if isinstance(item1, str):
1920			return Zone(super().Get(item1))
1921
1922		if isinstance(item1, int):
1923			return Zone(super().Get(item1))
1924
1925		result = self._Entity.Get(item1)
1926		thisClass = type(result).__name__
1927		givenClass = Zone
1928		for subclass in Zone.__subclasses__():
1929			if subclass.__name__ == thisClass:
1930				givenClass = subclass
1931		return givenClass(result)
1932
1933	def __getitem__(self, index: int):
1934		return self.ZoneColList[index]
1935
1936	def __iter__(self):
1937		yield from self.ZoneColList
1938
1939	def __len__(self):
1940		return len(self.ZoneColList)
1941
1942
1943class ZoneJointContainer(IdNameEntityRenameable):
1944	'''
1945	Represents an entity that contains a collection of Zones and Joints.
1946	'''
1947	def __init__(self, zoneJointContainer: _api.ZoneJointContainer):
1948		self._Entity = zoneJointContainer
1949
1950	@property
1951	def Centroid(self) -> Centroid:
1952		result = self._Entity.Centroid
1953		return Centroid(result) if result is not None else None
1954
1955	@property
1956	def Joints(self) -> JointCol:
1957		result = self._Entity.Joints
1958		return JointCol(result) if result is not None else None
1959
1960	@property
1961	def PanelSegments(self) -> PanelSegmentCol:
1962		result = self._Entity.PanelSegments
1963		return PanelSegmentCol(result) if result is not None else None
1964
1965	@property
1966	def TotalBeamLength(self) -> float:
1967		return self._Entity.TotalBeamLength
1968
1969	@property
1970	def TotalPanelArea(self) -> float:
1971		return self._Entity.TotalPanelArea
1972
1973	@property
1974	def TotalZoneWeight(self) -> float:
1975		return self._Entity.TotalZoneWeight
1976
1977	@property
1978	def Zones(self) -> ZoneCol:
1979		result = self._Entity.Zones
1980		return ZoneCol(result) if result is not None else None
1981
1982	@overload
1983	def AddJoint(self, id: int) -> CollectionModificationStatus: ...
1984
1985	@overload
1986	@abstractmethod
1987	def AddJoint(self, joint: Joint) -> CollectionModificationStatus: ...
1988
1989	@overload
1990	def RemoveJoint(self, id: int) -> CollectionModificationStatus: ...
1991
1992	@overload
1993	def RemoveJoint(self, joint: Joint) -> CollectionModificationStatus: ...
1994
1995	@overload
1996	@abstractmethod
1997	def RemoveJoints(self, jointIds: tuple[int]) -> CollectionModificationStatus: ...
1998
1999	@overload
2000	def RemoveJoints(self, joints: JointCol) -> CollectionModificationStatus: ...
2001
2002	@overload
2003	def AddZone(self, id: int) -> CollectionModificationStatus: ...
2004
2005	@overload
2006	def AddZones(self, ids: tuple[int]) -> CollectionModificationStatus: ...
2007
2008	@overload
2009	def AddZone(self, zone: Zone) -> CollectionModificationStatus: ...
2010
2011	@overload
2012	@abstractmethod
2013	def AddZones(self, zones: tuple[Zone]) -> CollectionModificationStatus: ...
2014
2015	@overload
2016	def RemoveZone(self, id: int) -> CollectionModificationStatus: ...
2017
2018	@overload
2019	def RemoveZone(self, zone: Zone) -> CollectionModificationStatus: ...
2020
2021	@overload
2022	@abstractmethod
2023	def RemoveZones(self, zoneIds: tuple[int]) -> CollectionModificationStatus: ...
2024
2025	@overload
2026	def RemoveZones(self, zones: ZoneCol) -> CollectionModificationStatus: ...
2027
2028	@overload
2029	def AddPanelSegment(self, id: int) -> CollectionModificationStatus: ...
2030
2031	@overload
2032	@abstractmethod
2033	def AddPanelSegment(self, segment: PanelSegment) -> CollectionModificationStatus: ...
2034
2035	@overload
2036	def RemovePanelSegment(self, id: int) -> CollectionModificationStatus: ...
2037
2038	@overload
2039	def RemovePanelSegment(self, segment: PanelSegment) -> CollectionModificationStatus: ...
2040
2041	@overload
2042	@abstractmethod
2043	def RemovePanelSegments(self, segmentIds: tuple[int]) -> CollectionModificationStatus: ...
2044
2045	@overload
2046	def RemovePanelSegments(self, segments: PanelSegmentCol) -> CollectionModificationStatus: ...
2047
2048	def AddJoint(self, item1 = None) -> CollectionModificationStatus:
2049		if isinstance(item1, int):
2050			return CollectionModificationStatus[self._Entity.AddJoint(item1).ToString()]
2051
2052		if isinstance(item1, Joint):
2053			return CollectionModificationStatus[self._Entity.AddJoint(item1._Entity).ToString()]
2054
2055		return CollectionModificationStatus[self._Entity.AddJoint(item1).ToString()]
2056
2057	def RemoveJoint(self, item1 = None) -> CollectionModificationStatus:
2058		if isinstance(item1, int):
2059			return CollectionModificationStatus[self._Entity.RemoveJoint(item1).ToString()]
2060
2061		if isinstance(item1, Joint):
2062			return CollectionModificationStatus[self._Entity.RemoveJoint(item1._Entity).ToString()]
2063
2064		return CollectionModificationStatus[self._Entity.RemoveJoint(item1).ToString()]
2065
2066	def RemoveJoints(self, item1 = None) -> CollectionModificationStatus:
2067		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
2068			jointIdsList = MakeCSharpIntList(item1)
2069			jointIdsEnumerable = IEnumerable(jointIdsList)
2070			return CollectionModificationStatus[self._Entity.RemoveJoints(jointIdsEnumerable).ToString()]
2071
2072		if isinstance(item1, JointCol):
2073			return CollectionModificationStatus[self._Entity.RemoveJoints(item1._Entity).ToString()]
2074
2075		return CollectionModificationStatus[self._Entity.RemoveJoints(item1).ToString()]
2076
2077	def AddZone(self, item1 = None) -> CollectionModificationStatus:
2078		if isinstance(item1, int):
2079			return CollectionModificationStatus[self._Entity.AddZone(item1).ToString()]
2080
2081		if isinstance(item1, Zone):
2082			return CollectionModificationStatus[self._Entity.AddZone(item1._Entity).ToString()]
2083
2084		return CollectionModificationStatus[self._Entity.AddZone(item1).ToString()]
2085
2086	def AddZones(self, item1 = None) -> CollectionModificationStatus:
2087		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
2088			idsList = MakeCSharpIntList(item1)
2089			idsEnumerable = IEnumerable(idsList)
2090			return CollectionModificationStatus[self._Entity.AddZones(idsEnumerable).ToString()]
2091
2092		if isinstance(item1, tuple) and item1 and isinstance(item1[0], Zone):
2093			zonesList = List[_api.Zone]()
2094			if item1 is not None:
2095				for thing in item1:
2096					if thing is not None:
2097						zonesList.Add(thing._Entity)
2098			zonesEnumerable = IEnumerable(zonesList)
2099			return CollectionModificationStatus[self._Entity.AddZones(zonesEnumerable).ToString()]
2100
2101		return CollectionModificationStatus[self._Entity.AddZones(item1).ToString()]
2102
2103	def RemoveZone(self, item1 = None) -> CollectionModificationStatus:
2104		if isinstance(item1, int):
2105			return CollectionModificationStatus[self._Entity.RemoveZone(item1).ToString()]
2106
2107		if isinstance(item1, Zone):
2108			return CollectionModificationStatus[self._Entity.RemoveZone(item1._Entity).ToString()]
2109
2110		return CollectionModificationStatus[self._Entity.RemoveZone(item1).ToString()]
2111
2112	def RemoveZones(self, item1 = None) -> CollectionModificationStatus:
2113		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
2114			zoneIdsList = MakeCSharpIntList(item1)
2115			zoneIdsEnumerable = IEnumerable(zoneIdsList)
2116			return CollectionModificationStatus[self._Entity.RemoveZones(zoneIdsEnumerable).ToString()]
2117
2118		if isinstance(item1, ZoneCol):
2119			return CollectionModificationStatus[self._Entity.RemoveZones(item1._Entity).ToString()]
2120
2121		return CollectionModificationStatus[self._Entity.RemoveZones(item1).ToString()]
2122
2123	def AddPanelSegment(self, item1 = None) -> CollectionModificationStatus:
2124		if isinstance(item1, int):
2125			return CollectionModificationStatus[self._Entity.AddPanelSegment(item1).ToString()]
2126
2127		if isinstance(item1, PanelSegment):
2128			return CollectionModificationStatus[self._Entity.AddPanelSegment(item1._Entity).ToString()]
2129
2130		return CollectionModificationStatus[self._Entity.AddPanelSegment(item1).ToString()]
2131
2132	def RemovePanelSegment(self, item1 = None) -> CollectionModificationStatus:
2133		if isinstance(item1, int):
2134			return CollectionModificationStatus[self._Entity.RemovePanelSegment(item1).ToString()]
2135
2136		if isinstance(item1, PanelSegment):
2137			return CollectionModificationStatus[self._Entity.RemovePanelSegment(item1._Entity).ToString()]
2138
2139		return CollectionModificationStatus[self._Entity.RemovePanelSegment(item1).ToString()]
2140
2141	def RemovePanelSegments(self, item1 = None) -> CollectionModificationStatus:
2142		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
2143			segmentIdsList = MakeCSharpIntList(item1)
2144			segmentIdsEnumerable = IEnumerable(segmentIdsList)
2145			return CollectionModificationStatus[self._Entity.RemovePanelSegments(segmentIdsEnumerable).ToString()]
2146
2147		if isinstance(item1, PanelSegmentCol):
2148			return CollectionModificationStatus[self._Entity.RemovePanelSegments(item1._Entity).ToString()]
2149
2150		return CollectionModificationStatus[self._Entity.RemovePanelSegments(item1).ToString()]
2151
2152
2153class AutomatedConstraint(IdNameEntityRenameable):
2154	def __init__(self, automatedConstraint: _api.AutomatedConstraint):
2155		self._Entity = automatedConstraint
2156
2157	@property
2158	def ConstraintType(self) -> types.StiffnessCriteriaType:
2159		return types.StiffnessCriteriaType[self._Entity.ConstraintType.ToString()]
2160
2161	@property
2162	def Set(self) -> str:
2163		return self._Entity.Set
2164
2165	@property
2166	def DesignLoadCases(self) -> list[str]:
2167		return [string for string in self._Entity.DesignLoadCases]
2168
2169	@Set.setter
2170	def Set(self, value: str) -> None:
2171		self._Entity.Set = value
2172
2173	def AddDesignLoadCases(self, designLoadCases: list[str]) -> None:
2174		designLoadCasesList = List[str]()
2175		if designLoadCases is not None:
2176			for thing in designLoadCases:
2177				if thing is not None:
2178					designLoadCasesList.Add(thing)
2179		return self._Entity.AddDesignLoadCases(designLoadCasesList)
2180
2181	def RemoveDesignLoadCases(self, designLoadCases: list[str]) -> None:
2182		designLoadCasesList = List[str]()
2183		if designLoadCases is not None:
2184			for thing in designLoadCases:
2185				if thing is not None:
2186					designLoadCasesList.Add(thing)
2187		return self._Entity.RemoveDesignLoadCases(designLoadCasesList)
2188
2189
2190class ModalAutomatedConstraint(AutomatedConstraint):
2191	def __init__(self, modalAutomatedConstraint: _api.ModalAutomatedConstraint):
2192		self._Entity = modalAutomatedConstraint
2193
2194	@property
2195	def Eigenvalue(self) -> float:
2196		return self._Entity.Eigenvalue
2197
2198	@Eigenvalue.setter
2199	def Eigenvalue(self, value: float) -> None:
2200		self._Entity.Eigenvalue = value
2201
2202
2203class BucklingAutomatedConstraint(ModalAutomatedConstraint):
2204	def __init__(self, bucklingAutomatedConstraint: _api.BucklingAutomatedConstraint):
2205		self._Entity = bucklingAutomatedConstraint
2206
2207
2208class StaticAutomatedConstraint(AutomatedConstraint):
2209	def __init__(self, staticAutomatedConstraint: _api.StaticAutomatedConstraint):
2210		self._Entity = staticAutomatedConstraint
2211
2212	@property
2213	def VirtualDesignLoad(self) -> str:
2214		return self._Entity.VirtualDesignLoad
2215
2216	@property
2217	def GridId(self) -> int:
2218		return self._Entity.GridId
2219
2220	@property
2221	def Orientation(self) -> types.DisplacementShapeType:
2222		return types.DisplacementShapeType[self._Entity.Orientation.ToString()]
2223
2224	@property
2225	def HasVector(self) -> bool:
2226		return self._Entity.HasVector
2227
2228	@property
2229	def X(self) -> float:
2230		return self._Entity.X
2231
2232	@property
2233	def Y(self) -> float:
2234		return self._Entity.Y
2235
2236	@property
2237	def Z(self) -> float:
2238		return self._Entity.Z
2239
2240	@VirtualDesignLoad.setter
2241	def VirtualDesignLoad(self, value: str) -> None:
2242		self._Entity.VirtualDesignLoad = value
2243
2244	@GridId.setter
2245	def GridId(self, value: int) -> None:
2246		self._Entity.GridId = value
2247
2248	@Orientation.setter
2249	def Orientation(self, value: types.DisplacementShapeType) -> None:
2250		self._Entity.Orientation = _types.DisplacementShapeType(value.value)
2251
2252	@X.setter
2253	def X(self, value: float) -> None:
2254		self._Entity.X = value
2255
2256	@Y.setter
2257	def Y(self, value: float) -> None:
2258		self._Entity.Y = value
2259
2260	@Z.setter
2261	def Z(self, value: float) -> None:
2262		self._Entity.Z = value
2263
2264
2265class DisplacementAutomatedConstraint(StaticAutomatedConstraint):
2266	def __init__(self, displacementAutomatedConstraint: _api.DisplacementAutomatedConstraint):
2267		self._Entity = displacementAutomatedConstraint
2268
2269	@property
2270	def Limit(self) -> float:
2271		return self._Entity.Limit
2272
2273	@Limit.setter
2274	def Limit(self, value: float) -> None:
2275		self._Entity.Limit = value
2276
2277
2278class FrequencyAutomatedConstraint(ModalAutomatedConstraint):
2279	def __init__(self, frequencyAutomatedConstraint: _api.FrequencyAutomatedConstraint):
2280		self._Entity = frequencyAutomatedConstraint
2281
2282
2283class RotationAutomatedConstraint(StaticAutomatedConstraint):
2284	def __init__(self, rotationAutomatedConstraint: _api.RotationAutomatedConstraint):
2285		self._Entity = rotationAutomatedConstraint
2286
2287	@property
2288	def Limit(self) -> float:
2289		return self._Entity.Limit
2290
2291	@Limit.setter
2292	def Limit(self, value: float) -> None:
2293		self._Entity.Limit = value
2294
2295
2296class ManualConstraint(IdNameEntityRenameable):
2297	def __init__(self, manualConstraint: _api.ManualConstraint):
2298		self._Entity = manualConstraint
2299
2300	@property
2301	def ConstraintType(self) -> types.ConstraintType:
2302		return types.ConstraintType[self._Entity.ConstraintType.ToString()]
2303
2304	@property
2305	def Set(self) -> str:
2306		return self._Entity.Set
2307
2308	@property
2309	def Limit(self) -> float:
2310		return self._Entity.Limit
2311
2312	@property
2313	def A11(self) -> bool:
2314		return self._Entity.A11
2315
2316	@property
2317	def A22(self) -> bool:
2318		return self._Entity.A22
2319
2320	@property
2321	def A33(self) -> bool:
2322		return self._Entity.A33
2323
2324	@property
2325	def D11(self) -> bool:
2326		return self._Entity.D11
2327
2328	@property
2329	def D22(self) -> bool:
2330		return self._Entity.D22
2331
2332	@property
2333	def D33(self) -> bool:
2334		return self._Entity.D33
2335
2336	@property
2337	def EA(self) -> bool:
2338		return self._Entity.EA
2339
2340	@property
2341	def EI1(self) -> bool:
2342		return self._Entity.EI1
2343
2344	@property
2345	def EI2(self) -> bool:
2346		return self._Entity.EI2
2347
2348	@property
2349	def GJ(self) -> bool:
2350		return self._Entity.GJ
2351
2352	@property
2353	def IsActive(self) -> bool:
2354		return self._Entity.IsActive
2355
2356	@Set.setter
2357	def Set(self, value: str) -> None:
2358		self._Entity.Set = value
2359
2360	@Limit.setter
2361	def Limit(self, value: float) -> None:
2362		self._Entity.Limit = value
2363
2364	@A11.setter
2365	def A11(self, value: bool) -> None:
2366		self._Entity.A11 = value
2367
2368	@A22.setter
2369	def A22(self, value: bool) -> None:
2370		self._Entity.A22 = value
2371
2372	@A33.setter
2373	def A33(self, value: bool) -> None:
2374		self._Entity.A33 = value
2375
2376	@D11.setter
2377	def D11(self, value: bool) -> None:
2378		self._Entity.D11 = value
2379
2380	@D22.setter
2381	def D22(self, value: bool) -> None:
2382		self._Entity.D22 = value
2383
2384	@D33.setter
2385	def D33(self, value: bool) -> None:
2386		self._Entity.D33 = value
2387
2388	@EA.setter
2389	def EA(self, value: bool) -> None:
2390		self._Entity.EA = value
2391
2392	@EI1.setter
2393	def EI1(self, value: bool) -> None:
2394		self._Entity.EI1 = value
2395
2396	@EI2.setter
2397	def EI2(self, value: bool) -> None:
2398		self._Entity.EI2 = value
2399
2400	@GJ.setter
2401	def GJ(self, value: bool) -> None:
2402		self._Entity.GJ = value
2403
2404	@IsActive.setter
2405	def IsActive(self, value: bool) -> None:
2406		self._Entity.IsActive = value
2407
2408
2409class ManualConstraintWithDesignLoad(ManualConstraint):
2410	def __init__(self, manualConstraintWithDesignLoad: _api.ManualConstraintWithDesignLoad):
2411		self._Entity = manualConstraintWithDesignLoad
2412
2413	@property
2414	def UseAllDesignLoads(self) -> bool:
2415		return self._Entity.UseAllDesignLoads
2416
2417	@property
2418	def DesignLoadCase(self) -> str:
2419		return self._Entity.DesignLoadCase
2420
2421	@UseAllDesignLoads.setter
2422	def UseAllDesignLoads(self, value: bool) -> None:
2423		self._Entity.UseAllDesignLoads = value
2424
2425	@DesignLoadCase.setter
2426	def DesignLoadCase(self, value: str) -> None:
2427		self._Entity.DesignLoadCase = value
2428
2429
2430class BucklingManualConstraint(ManualConstraintWithDesignLoad):
2431	def __init__(self, bucklingManualConstraint: _api.BucklingManualConstraint):
2432		self._Entity = bucklingManualConstraint
2433
2434
2435class DisplacementManualConstraint(ManualConstraintWithDesignLoad):
2436	def __init__(self, displacementManualConstraint: _api.DisplacementManualConstraint):
2437		self._Entity = displacementManualConstraint
2438
2439	@property
2440	def DOF(self) -> types.DegreeOfFreedom:
2441		return types.DegreeOfFreedom[self._Entity.DOF.ToString()]
2442
2443	@property
2444	def Nodes(self) -> list[int]:
2445		return [int32 for int32 in self._Entity.Nodes]
2446
2447	@property
2448	def RefNodes(self) -> list[int]:
2449		return [int32 for int32 in self._Entity.RefNodes]
2450
2451	@DOF.setter
2452	def DOF(self, value: types.DegreeOfFreedom) -> None:
2453		self._Entity.DOF = _types.DegreeOfFreedom(value.value)
2454
2455	def AddNodes(self, ids: list[int]) -> None:
2456		idsList = MakeCSharpIntList(ids)
2457		return self._Entity.AddNodes(idsList)
2458
2459	def RemoveNodes(self, ids: list[int]) -> None:
2460		idsList = MakeCSharpIntList(ids)
2461		return self._Entity.RemoveNodes(idsList)
2462
2463	def AddRefNodes(self, ids: list[int]) -> None:
2464		idsList = MakeCSharpIntList(ids)
2465		return self._Entity.AddRefNodes(idsList)
2466
2467	def RemoveRefNodes(self, ids: list[int]) -> None:
2468		idsList = MakeCSharpIntList(ids)
2469		return self._Entity.RemoveRefNodes(idsList)
2470
2471
2472class FrequencyManualConstraint(ManualConstraintWithDesignLoad):
2473	def __init__(self, frequencyManualConstraint: _api.FrequencyManualConstraint):
2474		self._Entity = frequencyManualConstraint
2475
2476
2477class StaticMomentManualConstraint(ManualConstraint):
2478	def __init__(self, staticMomentManualConstraint: _api.StaticMomentManualConstraint):
2479		self._Entity = staticMomentManualConstraint
2480
2481
2482class AutomatedConstraintCol(IdNameEntityCol[AutomatedConstraint]):
2483	def __init__(self, automatedConstraintCol: _api.AutomatedConstraintCol):
2484		self._Entity = automatedConstraintCol
2485		self._CollectedClass = AutomatedConstraint
2486
2487	@property
2488	def AutomatedConstraintColList(self) -> tuple[AutomatedConstraint]:
2489		return tuple([AutomatedConstraint(automatedConstraintCol) for automatedConstraintCol in self._Entity])
2490
2491	def AddBucklingConstraint(self, designLoads: list[str], eigenvalue: float, name: str = None) -> BucklingAutomatedConstraint:
2492		designLoadsList = List[str]()
2493		if designLoads is not None:
2494			for thing in designLoads:
2495				if thing is not None:
2496					designLoadsList.Add(thing)
2497		return BucklingAutomatedConstraint(self._Entity.AddBucklingConstraint(designLoadsList, eigenvalue, name))
2498
2499	def AddFrequencyConstraint(self, designLoads: list[str], eigenvalue: float, name: str = None) -> FrequencyAutomatedConstraint:
2500		designLoadsList = List[str]()
2501		if designLoads is not None:
2502			for thing in designLoads:
2503				if thing is not None:
2504					designLoadsList.Add(thing)
2505		return FrequencyAutomatedConstraint(self._Entity.AddFrequencyConstraint(designLoadsList, eigenvalue, name))
2506
2507	def AddDisplacementConstraint(self, designLoads: list[str], gridId: int, limit: float, name: str = None) -> DisplacementAutomatedConstraint:
2508		designLoadsList = List[str]()
2509		if designLoads is not None:
2510			for thing in designLoads:
2511				if thing is not None:
2512					designLoadsList.Add(thing)
2513		return DisplacementAutomatedConstraint(self._Entity.AddDisplacementConstraint(designLoadsList, gridId, limit, name))
2514
2515	def AddRotationConstraint(self, designLoads: list[str], gridId: int, limit: float, name: str = None) -> RotationAutomatedConstraint:
2516		designLoadsList = List[str]()
2517		if designLoads is not None:
2518			for thing in designLoads:
2519				if thing is not None:
2520					designLoadsList.Add(thing)
2521		return RotationAutomatedConstraint(self._Entity.AddRotationConstraint(designLoadsList, gridId, limit, name))
2522
2523	@overload
2524	def Delete(self, id: int) -> bool: ...
2525
2526	@overload
2527	def Delete(self, name: str) -> bool: ...
2528
2529	@overload
2530	def GetBuckling(self, id: int) -> BucklingAutomatedConstraint: ...
2531
2532	@overload
2533	def GetBuckling(self, name: str) -> BucklingAutomatedConstraint: ...
2534
2535	@overload
2536	def GetFrequency(self, id: int) -> FrequencyAutomatedConstraint: ...
2537
2538	@overload
2539	def GetFrequency(self, name: str) -> FrequencyAutomatedConstraint: ...
2540
2541	@overload
2542	def GetRotation(self, id: int) -> RotationAutomatedConstraint: ...
2543
2544	@overload
2545	def GetRotation(self, name: str) -> RotationAutomatedConstraint: ...
2546
2547	@overload
2548	def GetDisplacement(self, id: int) -> DisplacementAutomatedConstraint: ...
2549
2550	@overload
2551	def GetDisplacement(self, name: str) -> DisplacementAutomatedConstraint: ...
2552
2553	@overload
2554	def Get(self, name: str) -> AutomatedConstraint: ...
2555
2556	@overload
2557	def Get(self, id: int) -> AutomatedConstraint: ...
2558
2559	def Delete(self, item1 = None) -> bool:
2560		if isinstance(item1, int):
2561			return self._Entity.Delete(item1)
2562
2563		if isinstance(item1, str):
2564			return self._Entity.Delete(item1)
2565
2566		return self._Entity.Delete(item1)
2567
2568	def GetBuckling(self, item1 = None) -> BucklingAutomatedConstraint:
2569		if isinstance(item1, int):
2570			return BucklingAutomatedConstraint(self._Entity.GetBuckling(item1))
2571
2572		if isinstance(item1, str):
2573			return BucklingAutomatedConstraint(self._Entity.GetBuckling(item1))
2574
2575		return BucklingAutomatedConstraint(self._Entity.GetBuckling(item1))
2576
2577	def GetFrequency(self, item1 = None) -> FrequencyAutomatedConstraint:
2578		if isinstance(item1, int):
2579			return FrequencyAutomatedConstraint(self._Entity.GetFrequency(item1))
2580
2581		if isinstance(item1, str):
2582			return FrequencyAutomatedConstraint(self._Entity.GetFrequency(item1))
2583
2584		return FrequencyAutomatedConstraint(self._Entity.GetFrequency(item1))
2585
2586	def GetRotation(self, item1 = None) -> RotationAutomatedConstraint:
2587		if isinstance(item1, int):
2588			return RotationAutomatedConstraint(self._Entity.GetRotation(item1))
2589
2590		if isinstance(item1, str):
2591			return RotationAutomatedConstraint(self._Entity.GetRotation(item1))
2592
2593		return RotationAutomatedConstraint(self._Entity.GetRotation(item1))
2594
2595	def GetDisplacement(self, item1 = None) -> DisplacementAutomatedConstraint:
2596		if isinstance(item1, int):
2597			return DisplacementAutomatedConstraint(self._Entity.GetDisplacement(item1))
2598
2599		if isinstance(item1, str):
2600			return DisplacementAutomatedConstraint(self._Entity.GetDisplacement(item1))
2601
2602		return DisplacementAutomatedConstraint(self._Entity.GetDisplacement(item1))
2603
2604	def Get(self, item1 = None) -> AutomatedConstraint:
2605		if isinstance(item1, str):
2606			return AutomatedConstraint(super().Get(item1))
2607
2608		if isinstance(item1, int):
2609			return AutomatedConstraint(super().Get(item1))
2610
2611		result = self._Entity.Get(item1)
2612		thisClass = type(result).__name__
2613		givenClass = AutomatedConstraint
2614		for subclass in AutomatedConstraint.__subclasses__():
2615			if subclass.__name__ == thisClass:
2616				givenClass = subclass
2617		return givenClass(result)
2618
2619	def __getitem__(self, index: int):
2620		return self.AutomatedConstraintColList[index]
2621
2622	def __iter__(self):
2623		yield from self.AutomatedConstraintColList
2624
2625	def __len__(self):
2626		return len(self.AutomatedConstraintColList)
2627
2628
2629class ManualConstraintCol(IdNameEntityCol[ManualConstraint]):
2630	def __init__(self, manualConstraintCol: _api.ManualConstraintCol):
2631		self._Entity = manualConstraintCol
2632		self._CollectedClass = ManualConstraint
2633
2634	@property
2635	def ManualConstraintColList(self) -> tuple[ManualConstraint]:
2636		return tuple([ManualConstraint(manualConstraintCol) for manualConstraintCol in self._Entity])
2637
2638	@overload
2639	def GetFrequency(self, id: int) -> FrequencyManualConstraint: ...
2640
2641	@overload
2642	def GetFrequency(self, name: str) -> FrequencyManualConstraint: ...
2643
2644	@overload
2645	def GetBuckling(self, id: int) -> BucklingManualConstraint: ...
2646
2647	@overload
2648	def GetBuckling(self, name: str) -> BucklingManualConstraint: ...
2649
2650	@overload
2651	def GetDisplacement(self, id: int) -> DisplacementManualConstraint: ...
2652
2653	@overload
2654	def GetDisplacement(self, name: str) -> DisplacementManualConstraint: ...
2655
2656	@overload
2657	def GetStaticMoment(self, id: int) -> StaticMomentManualConstraint: ...
2658
2659	@overload
2660	def GetStaticMoment(self, name: str) -> StaticMomentManualConstraint: ...
2661
2662	def AddFrequencyConstraint(self, setName: str, limit: float, name: str = None) -> FrequencyManualConstraint:
2663		return FrequencyManualConstraint(self._Entity.AddFrequencyConstraint(setName, limit, name))
2664
2665	def AddBucklingConstraint(self, setName: str, limit: float, name: str = None) -> BucklingManualConstraint:
2666		return BucklingManualConstraint(self._Entity.AddBucklingConstraint(setName, limit, name))
2667
2668	def AddStaticMomentManualConstraint(self, setName: str, limit: float, name: str = None) -> StaticMomentManualConstraint:
2669		return StaticMomentManualConstraint(self._Entity.AddStaticMomentManualConstraint(setName, limit, name))
2670
2671	def AddDisplacementConstraint(self, setName: str, gridIds: list[int], limit: float, name: str = None) -> DisplacementManualConstraint:
2672		gridIdsList = MakeCSharpIntList(gridIds)
2673		return DisplacementManualConstraint(self._Entity.AddDisplacementConstraint(setName, gridIdsList, limit, name))
2674
2675	@overload
2676	def DeleteConstraint(self, name: str) -> bool: ...
2677
2678	@overload
2679	def DeleteConstraint(self, id: int) -> bool: ...
2680
2681	@overload
2682	def Get(self, name: str) -> ManualConstraint: ...
2683
2684	@overload
2685	def Get(self, id: int) -> ManualConstraint: ...
2686
2687	def GetFrequency(self, item1 = None) -> FrequencyManualConstraint:
2688		if isinstance(item1, int):
2689			return FrequencyManualConstraint(self._Entity.GetFrequency(item1))
2690
2691		if isinstance(item1, str):
2692			return FrequencyManualConstraint(self._Entity.GetFrequency(item1))
2693
2694		return FrequencyManualConstraint(self._Entity.GetFrequency(item1))
2695
2696	def GetBuckling(self, item1 = None) -> BucklingManualConstraint:
2697		if isinstance(item1, int):
2698			return BucklingManualConstraint(self._Entity.GetBuckling(item1))
2699
2700		if isinstance(item1, str):
2701			return BucklingManualConstraint(self._Entity.GetBuckling(item1))
2702
2703		return BucklingManualConstraint(self._Entity.GetBuckling(item1))
2704
2705	def GetDisplacement(self, item1 = None) -> DisplacementManualConstraint:
2706		if isinstance(item1, int):
2707			return DisplacementManualConstraint(self._Entity.GetDisplacement(item1))
2708
2709		if isinstance(item1, str):
2710			return DisplacementManualConstraint(self._Entity.GetDisplacement(item1))
2711
2712		return DisplacementManualConstraint(self._Entity.GetDisplacement(item1))
2713
2714	def GetStaticMoment(self, item1 = None) -> StaticMomentManualConstraint:
2715		if isinstance(item1, int):
2716			return StaticMomentManualConstraint(self._Entity.GetStaticMoment(item1))
2717
2718		if isinstance(item1, str):
2719			return StaticMomentManualConstraint(self._Entity.GetStaticMoment(item1))
2720
2721		return StaticMomentManualConstraint(self._Entity.GetStaticMoment(item1))
2722
2723	def DeleteConstraint(self, item1 = None) -> bool:
2724		if isinstance(item1, str):
2725			return self._Entity.DeleteConstraint(item1)
2726
2727		if isinstance(item1, int):
2728			return self._Entity.DeleteConstraint(item1)
2729
2730		return self._Entity.DeleteConstraint(item1)
2731
2732	def Get(self, item1 = None) -> ManualConstraint:
2733		if isinstance(item1, str):
2734			return ManualConstraint(super().Get(item1))
2735
2736		if isinstance(item1, int):
2737			return ManualConstraint(super().Get(item1))
2738
2739		return ManualConstraint(self._Entity.Get(item1))
2740
2741	def __getitem__(self, index: int):
2742		return self.ManualConstraintColList[index]
2743
2744	def __iter__(self):
2745		yield from self.ManualConstraintColList
2746
2747	def __len__(self):
2748		return len(self.ManualConstraintColList)
2749
2750
2751class HyperFea:
2752	def __init__(self, hyperFea: _api.HyperFea):
2753		self._Entity = hyperFea
2754
2755	@property
2756	def ManualConstraints(self) -> ManualConstraintCol:
2757		result = self._Entity.ManualConstraints
2758		return ManualConstraintCol(result) if result is not None else None
2759
2760	@property
2761	def AutomatedConstraints(self) -> AutomatedConstraintCol:
2762		result = self._Entity.AutomatedConstraints
2763		return AutomatedConstraintCol(result) if result is not None else None
2764
2765	def RunIterations(self, numberOfIterations: int, startWithSizing: bool) -> None:
2766		return self._Entity.RunIterations(numberOfIterations, startWithSizing)
2767
2768	def SetupSolver(self, solverPath: str, arguments: str) -> types.SimpleStatus:
2769		return types.SimpleStatus(self._Entity.SetupSolver(solverPath, arguments))
2770
2771	def TestSolver(self) -> types.SimpleStatus:
2772		'''
2773		Test FEA solver setup.
2774		'''
2775		return types.SimpleStatus(self._Entity.TestSolver())
2776
2777	def GetSolverSetup(self) -> types.HyperFeaSolver:
2778		'''
2779		Get the current FEA solver setup.
2780		'''
2781		return types.HyperFeaSolver(self._Entity.GetSolverSetup())
2782
2783
2784class FoamTemperature:
2785	'''
2786	Foam material temperature dependent properties.
2787	'''
2788	def __init__(self, foamTemperature: _api.FoamTemperature):
2789		self._Entity = foamTemperature
2790
2791	@property
2792	def Temperature(self) -> float:
2793		return self._Entity.Temperature
2794
2795	@property
2796	def Et(self) -> float:
2797		return self._Entity.Et
2798
2799	@property
2800	def Ec(self) -> float:
2801		return self._Entity.Ec
2802
2803	@property
2804	def G(self) -> float:
2805		return self._Entity.G
2806
2807	@property
2808	def Ef(self) -> float:
2809		return self._Entity.Ef
2810
2811	@property
2812	def Ftu(self) -> float:
2813		return self._Entity.Ftu
2814
2815	@property
2816	def Fcu(self) -> float:
2817		return self._Entity.Fcu
2818
2819	@property
2820	def Fsu(self) -> float:
2821		return self._Entity.Fsu
2822
2823	@property
2824	def Ffu(self) -> float:
2825		return self._Entity.Ffu
2826
2827	@property
2828	def K(self) -> float:
2829		return self._Entity.K
2830
2831	@property
2832	def C(self) -> float:
2833		return self._Entity.C
2834
2835	@Temperature.setter
2836	def Temperature(self, value: float) -> None:
2837		self._Entity.Temperature = value
2838
2839	@Et.setter
2840	def Et(self, value: float) -> None:
2841		self._Entity.Et = value
2842
2843	@Ec.setter
2844	def Ec(self, value: float) -> None:
2845		self._Entity.Ec = value
2846
2847	@G.setter
2848	def G(self, value: float) -> None:
2849		self._Entity.G = value
2850
2851	@Ef.setter
2852	def Ef(self, value: float) -> None:
2853		self._Entity.Ef = value
2854
2855	@Ftu.setter
2856	def Ftu(self, value: float) -> None:
2857		self._Entity.Ftu = value
2858
2859	@Fcu.setter
2860	def Fcu(self, value: float) -> None:
2861		self._Entity.Fcu = value
2862
2863	@Fsu.setter
2864	def Fsu(self, value: float) -> None:
2865		self._Entity.Fsu = value
2866
2867	@Ffu.setter
2868	def Ffu(self, value: float) -> None:
2869		self._Entity.Ffu = value
2870
2871	@K.setter
2872	def K(self, value: float) -> None:
2873		self._Entity.K = value
2874
2875	@C.setter
2876	def C(self, value: float) -> None:
2877		self._Entity.C = value
2878
2879
2880class Foam:
2881	'''
2882	Foam material.
2883	'''
2884	def __init__(self, foam: _api.Foam):
2885		self._Entity = foam
2886
2887	@property
2888	def MaterialFamilyName(self) -> str:
2889		return self._Entity.MaterialFamilyName
2890
2891	@property
2892	def Id(self) -> int:
2893		return self._Entity.Id
2894
2895	@property
2896	def CreationDate(self) -> DateTime:
2897		return self._Entity.CreationDate
2898
2899	@property
2900	def ModificationDate(self) -> DateTime:
2901		return self._Entity.ModificationDate
2902
2903	@property
2904	def Name(self) -> str:
2905		return self._Entity.Name
2906
2907	@property
2908	def Wet(self) -> bool:
2909		return self._Entity.Wet
2910
2911	@property
2912	def Density(self) -> float:
2913		return self._Entity.Density
2914
2915	@property
2916	def Form(self) -> str:
2917		return self._Entity.Form
2918
2919	@property
2920	def Specification(self) -> str:
2921		return self._Entity.Specification
2922
2923	@property
2924	def MaterialDescription(self) -> str:
2925		return self._Entity.MaterialDescription
2926
2927	@property
2928	def UserNote(self) -> str:
2929		return self._Entity.UserNote
2930
2931	@property
2932	def FemMaterialId(self) -> int:
2933		return self._Entity.FemMaterialId
2934
2935	@property
2936	def Cost(self) -> float:
2937		return self._Entity.Cost
2938
2939	@property
2940	def BucklingStiffnessKnockdown(self) -> float:
2941		return self._Entity.BucklingStiffnessKnockdown
2942
2943	@property
2944	def Absorption(self) -> float:
2945		return self._Entity.Absorption
2946
2947	@property
2948	def Manufacturer(self) -> str:
2949		return self._Entity.Manufacturer
2950
2951	@property
2952	def FoamTemperatureProperties(self) -> list[FoamTemperature]:
2953		return [FoamTemperature(foamTemperature) for foamTemperature in self._Entity.FoamTemperatureProperties]
2954
2955	@MaterialFamilyName.setter
2956	def MaterialFamilyName(self, value: str) -> None:
2957		self._Entity.MaterialFamilyName = value
2958
2959	@Name.setter
2960	def Name(self, value: str) -> None:
2961		self._Entity.Name = value
2962
2963	@Wet.setter
2964	def Wet(self, value: bool) -> None:
2965		self._Entity.Wet = value
2966
2967	@Density.setter
2968	def Density(self, value: float) -> None:
2969		self._Entity.Density = value
2970
2971	@Form.setter
2972	def Form(self, value: str) -> None:
2973		self._Entity.Form = value
2974
2975	@Specification.setter
2976	def Specification(self, value: str) -> None:
2977		self._Entity.Specification = value
2978
2979	@MaterialDescription.setter
2980	def MaterialDescription(self, value: str) -> None:
2981		self._Entity.MaterialDescription = value
2982
2983	@UserNote.setter
2984	def UserNote(self, value: str) -> None:
2985		self._Entity.UserNote = value
2986
2987	@FemMaterialId.setter
2988	def FemMaterialId(self, value: int) -> None:
2989		self._Entity.FemMaterialId = value
2990
2991	@Cost.setter
2992	def Cost(self, value: float) -> None:
2993		self._Entity.Cost = value
2994
2995	@BucklingStiffnessKnockdown.setter
2996	def BucklingStiffnessKnockdown(self, value: float) -> None:
2997		self._Entity.BucklingStiffnessKnockdown = value
2998
2999	@Absorption.setter
3000	def Absorption(self, value: float) -> None:
3001		self._Entity.Absorption = value
3002
3003	@Manufacturer.setter
3004	def Manufacturer(self, value: str) -> None:
3005		self._Entity.Manufacturer = value
3006
3007	def AddTemperatureProperty(self, temperature: float, et: float, ec: float, g: float, ftu: float, fcu: float, fsu: float, ef: float = None, ffu: float = None, k: float = None, c: float = None) -> FoamTemperature:
3008		return FoamTemperature(self._Entity.AddTemperatureProperty(temperature, et, ec, g, ftu, fcu, fsu, ef, ffu, k, c))
3009
3010	def DeleteTemperatureProperty(self, temperature: float) -> bool:
3011		return self._Entity.DeleteTemperatureProperty(temperature)
3012
3013	def GetTemperature(self, lookupTemperature: float) -> FoamTemperature:
3014		return FoamTemperature(self._Entity.GetTemperature(lookupTemperature))
3015
3016	def Save(self) -> None:
3017		'''
3018		Save any changes to this foam material to the database.
3019		'''
3020		return self._Entity.Save()
3021
3022
3023class HoneycombTemperature:
3024	'''
3025	Honeycomb material temperature dependent properties.
3026	'''
3027	def __init__(self, honeycombTemperature: _api.HoneycombTemperature):
3028		self._Entity = honeycombTemperature
3029
3030	@property
3031	def Temperature(self) -> float:
3032		return self._Entity.Temperature
3033
3034	@property
3035	def Et(self) -> float:
3036		return self._Entity.Et
3037
3038	@property
3039	def Ec(self) -> float:
3040		return self._Entity.Ec
3041
3042	@property
3043	def Gw(self) -> float:
3044		return self._Entity.Gw
3045
3046	@property
3047	def Gl(self) -> float:
3048		return self._Entity.Gl
3049
3050	@property
3051	def Ftu(self) -> float:
3052		return self._Entity.Ftu
3053
3054	@property
3055	def Fcus(self) -> float:
3056		return self._Entity.Fcus
3057
3058	@property
3059	def Fcub(self) -> float:
3060		return self._Entity.Fcub
3061
3062	@property
3063	def Fcuc(self) -> float:
3064		return self._Entity.Fcuc
3065
3066	@property
3067	def Fsuw(self) -> float:
3068		return self._Entity.Fsuw
3069
3070	@property
3071	def Fsul(self) -> float:
3072		return self._Entity.Fsul
3073
3074	@property
3075	def SScfl(self) -> float:
3076		return self._Entity.SScfl
3077
3078	@property
3079	def SScfh(self) -> float:
3080		return self._Entity.SScfh
3081
3082	@property
3083	def Kl(self) -> float:
3084		return self._Entity.Kl
3085
3086	@property
3087	def Kw(self) -> float:
3088		return self._Entity.Kw
3089
3090	@property
3091	def Kt(self) -> float:
3092		return self._Entity.Kt
3093
3094	@property
3095	def C(self) -> float:
3096		return self._Entity.C
3097
3098	@Temperature.setter
3099	def Temperature(self, value: float) -> None:
3100		self._Entity.Temperature = value
3101
3102	@Et.setter
3103	def Et(self, value: float) -> None:
3104		self._Entity.Et = value
3105
3106	@Ec.setter
3107	def Ec(self, value: float) -> None:
3108		self._Entity.Ec = value
3109
3110	@Gw.setter
3111	def Gw(self, value: float) -> None:
3112		self._Entity.Gw = value
3113
3114	@Gl.setter
3115	def Gl(self, value: float) -> None:
3116		self._Entity.Gl = value
3117
3118	@Ftu.setter
3119	def Ftu(self, value: float) -> None:
3120		self._Entity.Ftu = value
3121
3122	@Fcus.setter
3123	def Fcus(self, value: float) -> None:
3124		self._Entity.Fcus = value
3125
3126	@Fcub.setter
3127	def Fcub(self, value: float) -> None:
3128		self._Entity.Fcub = value
3129
3130	@Fcuc.setter
3131	def Fcuc(self, value: float) -> None:
3132		self._Entity.Fcuc = value
3133
3134	@Fsuw.setter
3135	def Fsuw(self, value: float) -> None:
3136		self._Entity.Fsuw = value
3137
3138	@Fsul.setter
3139	def Fsul(self, value: float) -> None:
3140		self._Entity.Fsul = value
3141
3142	@SScfl.setter
3143	def SScfl(self, value: float) -> None:
3144		self._Entity.SScfl = value
3145
3146	@SScfh.setter
3147	def SScfh(self, value: float) -> None:
3148		self._Entity.SScfh = value
3149
3150	@Kl.setter
3151	def Kl(self, value: float) -> None:
3152		self._Entity.Kl = value
3153
3154	@Kw.setter
3155	def Kw(self, value: float) -> None:
3156		self._Entity.Kw = value
3157
3158	@Kt.setter
3159	def Kt(self, value: float) -> None:
3160		self._Entity.Kt = value
3161
3162	@C.setter
3163	def C(self, value: float) -> None:
3164		self._Entity.C = value
3165
3166
3167class Honeycomb:
3168	'''
3169	Honeycomb material.
3170	'''
3171	def __init__(self, honeycomb: _api.Honeycomb):
3172		self._Entity = honeycomb
3173
3174	@property
3175	def MaterialFamilyName(self) -> str:
3176		return self._Entity.MaterialFamilyName
3177
3178	@property
3179	def Id(self) -> int:
3180		return self._Entity.Id
3181
3182	@property
3183	def CreationDate(self) -> DateTime:
3184		return self._Entity.CreationDate
3185
3186	@property
3187	def ModificationDate(self) -> DateTime:
3188		return self._Entity.ModificationDate
3189
3190	@property
3191	def Name(self) -> str:
3192		return self._Entity.Name
3193
3194	@property
3195	def Wet(self) -> bool:
3196		return self._Entity.Wet
3197
3198	@property
3199	def Density(self) -> float:
3200		return self._Entity.Density
3201
3202	@property
3203	def Form(self) -> str:
3204		return self._Entity.Form
3205
3206	@property
3207	def Specification(self) -> str:
3208		return self._Entity.Specification
3209
3210	@property
3211	def MaterialDescription(self) -> str:
3212		return self._Entity.MaterialDescription
3213
3214	@property
3215	def UserNote(self) -> str:
3216		return self._Entity.UserNote
3217
3218	@property
3219	def FemMaterialId(self) -> int:
3220		return self._Entity.FemMaterialId
3221
3222	@property
3223	def Cost(self) -> float:
3224		return self._Entity.Cost
3225
3226	@property
3227	def CellSize(self) -> float:
3228		return self._Entity.CellSize
3229
3230	@property
3231	def Manufacturer(self) -> str:
3232		return self._Entity.Manufacturer
3233
3234	@property
3235	def HoneycombTemperatureProperties(self) -> list[HoneycombTemperature]:
3236		return [HoneycombTemperature(honeycombTemperature) for honeycombTemperature in self._Entity.HoneycombTemperatureProperties]
3237
3238	@MaterialFamilyName.setter
3239	def MaterialFamilyName(self, value: str) -> None:
3240		self._Entity.MaterialFamilyName = value
3241
3242	@Name.setter
3243	def Name(self, value: str) -> None:
3244		self._Entity.Name = value
3245
3246	@Wet.setter
3247	def Wet(self, value: bool) -> None:
3248		self._Entity.Wet = value
3249
3250	@Density.setter
3251	def Density(self, value: float) -> None:
3252		self._Entity.Density = value
3253
3254	@Form.setter
3255	def Form(self, value: str) -> None:
3256		self._Entity.Form = value
3257
3258	@Specification.setter
3259	def Specification(self, value: str) -> None:
3260		self._Entity.Specification = value
3261
3262	@MaterialDescription.setter
3263	def MaterialDescription(self, value: str) -> None:
3264		self._Entity.MaterialDescription = value
3265
3266	@UserNote.setter
3267	def UserNote(self, value: str) -> None:
3268		self._Entity.UserNote = value
3269
3270	@FemMaterialId.setter
3271	def FemMaterialId(self, value: int) -> None:
3272		self._Entity.FemMaterialId = value
3273
3274	@Cost.setter
3275	def Cost(self, value: float) -> None:
3276		self._Entity.Cost = value
3277
3278	@CellSize.setter
3279	def CellSize(self, value: float) -> None:
3280		self._Entity.CellSize = value
3281
3282	@Manufacturer.setter
3283	def Manufacturer(self, value: str) -> None:
3284		self._Entity.Manufacturer = value
3285
3286	def AddTemperatureProperty(self, temperature: float, et: float, ec: float, gw: float, gl: float, ftu: float, fcus: float, fcub: float, fcuc: float, fsuw: float, fsul: float, sScfl: float = None, sScfh: float = None, k1: float = None, k2: float = None, k3: float = None, c: float = None) -> HoneycombTemperature:
3287		return HoneycombTemperature(self._Entity.AddTemperatureProperty(temperature, et, ec, gw, gl, ftu, fcus, fcub, fcuc, fsuw, fsul, sScfl, sScfh, k1, k2, k3, c))
3288
3289	def DeleteTemperatureProperty(self, temperature: float) -> bool:
3290		return self._Entity.DeleteTemperatureProperty(temperature)
3291
3292	def GetTemperature(self, lookupTemperature: float) -> HoneycombTemperature:
3293		return HoneycombTemperature(self._Entity.GetTemperature(lookupTemperature))
3294
3295	def Save(self) -> None:
3296		'''
3297		Save any changes to this honeycomb material to the database.
3298		'''
3299		return self._Entity.Save()
3300
3301
3302class IsotropicTemperature:
3303	'''
3304	Isotropic material temperature dependent properties.
3305	'''
3306	def __init__(self, isotropicTemperature: _api.IsotropicTemperature):
3307		self._Entity = isotropicTemperature
3308
3309	@property
3310	def Temperature(self) -> float:
3311		return self._Entity.Temperature
3312
3313	@property
3314	def Et(self) -> float:
3315		return self._Entity.Et
3316
3317	@property
3318	def Ec(self) -> float:
3319		return self._Entity.Ec
3320
3321	@property
3322	def G(self) -> float:
3323		return self._Entity.G
3324
3325	@property
3326	def n(self) -> float:
3327		return self._Entity.n
3328
3329	@property
3330	def F02(self) -> float:
3331		return self._Entity.F02
3332
3333	@property
3334	def FtuL(self) -> float:
3335		return self._Entity.FtuL
3336
3337	@property
3338	def FtyL(self) -> float:
3339		return self._Entity.FtyL
3340
3341	@property
3342	def FcyL(self) -> float:
3343		return self._Entity.FcyL
3344
3345	@property
3346	def FtuLT(self) -> float:
3347		return self._Entity.FtuLT
3348
3349	@property
3350	def FtyLT(self) -> float:
3351		return self._Entity.FtyLT
3352
3353	@property
3354	def FcyLT(self) -> float:
3355		return self._Entity.FcyLT
3356
3357	@property
3358	def Fsu(self) -> float:
3359		return self._Entity.Fsu
3360
3361	@property
3362	def Fbru15(self) -> float:
3363		return self._Entity.Fbru15
3364
3365	@property
3366	def Fbry15(self) -> float:
3367		return self._Entity.Fbry15
3368
3369	@property
3370	def Fbru20(self) -> float:
3371		return self._Entity.Fbru20
3372
3373	@property
3374	def Fbry20(self) -> float:
3375		return self._Entity.Fbry20
3376
3377	@property
3378	def alpha(self) -> float:
3379		return self._Entity.alpha
3380
3381	@property
3382	def K(self) -> float:
3383		return self._Entity.K
3384
3385	@property
3386	def C(self) -> float:
3387		return self._Entity.C
3388
3389	@property
3390	def etyL(self) -> float:
3391		return self._Entity.etyL
3392
3393	@property
3394	def ecyL(self) -> float:
3395		return self._Entity.ecyL
3396
3397	@property
3398	def etyLT(self) -> float:
3399		return self._Entity.etyLT
3400
3401	@property
3402	def ecyLT(self) -> float:
3403		return self._Entity.ecyLT
3404
3405	@property
3406	def esu(self) -> float:
3407		return self._Entity.esu
3408
3409	@property
3410	def Fpadh(self) -> float:
3411		return self._Entity.Fpadh
3412
3413	@property
3414	def Fsadh(self) -> float:
3415		return self._Entity.Fsadh
3416
3417	@property
3418	def esadh(self) -> float:
3419		return self._Entity.esadh
3420
3421	@property
3422	def cd(self) -> float:
3423		return self._Entity.cd
3424
3425	@property
3426	def Ffwt(self) -> float:
3427		return self._Entity.Ffwt
3428
3429	@property
3430	def Ffxz(self) -> float:
3431		return self._Entity.Ffxz
3432
3433	@property
3434	def Ffyz(self) -> float:
3435		return self._Entity.Ffyz
3436
3437	@property
3438	def FtFatigue(self) -> float:
3439		return self._Entity.FtFatigue
3440
3441	@property
3442	def FcFatigue(self) -> float:
3443		return self._Entity.FcFatigue
3444
3445	@Temperature.setter
3446	def Temperature(self, value: float) -> None:
3447		self._Entity.Temperature = value
3448
3449	@Et.setter
3450	def Et(self, value: float) -> None:
3451		self._Entity.Et = value
3452
3453	@Ec.setter
3454	def Ec(self, value: float) -> None:
3455		self._Entity.Ec = value
3456
3457	@G.setter
3458	def G(self, value: float) -> None:
3459		self._Entity.G = value
3460
3461	@n.setter
3462	def n(self, value: float) -> None:
3463		self._Entity.n = value
3464
3465	@F02.setter
3466	def F02(self, value: float) -> None:
3467		self._Entity.F02 = value
3468
3469	@FtuL.setter
3470	def FtuL(self, value: float) -> None:
3471		self._Entity.FtuL = value
3472
3473	@FtyL.setter
3474	def FtyL(self, value: float) -> None:
3475		self._Entity.FtyL = value
3476
3477	@FcyL.setter
3478	def FcyL(self, value: float) -> None:
3479		self._Entity.FcyL = value
3480
3481	@FtuLT.setter
3482	def FtuLT(self, value: float) -> None:
3483		self._Entity.FtuLT = value
3484
3485	@FtyLT.setter
3486	def FtyLT(self, value: float) -> None:
3487		self._Entity.FtyLT = value
3488
3489	@FcyLT.setter
3490	def FcyLT(self, value: float) -> None:
3491		self._Entity.FcyLT = value
3492
3493	@Fsu.setter
3494	def Fsu(self, value: float) -> None:
3495		self._Entity.Fsu = value
3496
3497	@Fbru15.setter
3498	def Fbru15(self, value: float) -> None:
3499		self._Entity.Fbru15 = value
3500
3501	@Fbry15.setter
3502	def Fbry15(self, value: float) -> None:
3503		self._Entity.Fbry15 = value
3504
3505	@Fbru20.setter
3506	def Fbru20(self, value: float) -> None:
3507		self._Entity.Fbru20 = value
3508
3509	@Fbry20.setter
3510	def Fbry20(self, value: float) -> None:
3511		self._Entity.Fbry20 = value
3512
3513	@alpha.setter
3514	def alpha(self, value: float) -> None:
3515		self._Entity.alpha = value
3516
3517	@K.setter
3518	def K(self, value: float) -> None:
3519		self._Entity.K = value
3520
3521	@C.setter
3522	def C(self, value: float) -> None:
3523		self._Entity.C = value
3524
3525	@etyL.setter
3526	def etyL(self, value: float) -> None:
3527		self._Entity.etyL = value
3528
3529	@ecyL.setter
3530	def ecyL(self, value: float) -> None:
3531		self._Entity.ecyL = value
3532
3533	@etyLT.setter
3534	def etyLT(self, value: float) -> None:
3535		self._Entity.etyLT = value
3536
3537	@ecyLT.setter
3538	def ecyLT(self, value: float) -> None:
3539		self._Entity.ecyLT = value
3540
3541	@esu.setter
3542	def esu(self, value: float) -> None:
3543		self._Entity.esu = value
3544
3545	@Fpadh.setter
3546	def Fpadh(self, value: float) -> None:
3547		self._Entity.Fpadh = value
3548
3549	@Fsadh.setter
3550	def Fsadh(self, value: float) -> None:
3551		self._Entity.Fsadh = value
3552
3553	@esadh.setter
3554	def esadh(self, value: float) -> None:
3555		self._Entity.esadh = value
3556
3557	@cd.setter
3558	def cd(self, value: float) -> None:
3559		self._Entity.cd = value
3560
3561	@Ffwt.setter
3562	def Ffwt(self, value: float) -> None:
3563		self._Entity.Ffwt = value
3564
3565	@Ffxz.setter
3566	def Ffxz(self, value: float) -> None:
3567		self._Entity.Ffxz = value
3568
3569	@Ffyz.setter
3570	def Ffyz(self, value: float) -> None:
3571		self._Entity.Ffyz = value
3572
3573	@FtFatigue.setter
3574	def FtFatigue(self, value: float) -> None:
3575		self._Entity.FtFatigue = value
3576
3577	@FcFatigue.setter
3578	def FcFatigue(self, value: float) -> None:
3579		self._Entity.FcFatigue = value
3580
3581
3582class Isotropic:
3583	'''
3584	Isotropic material.
3585	'''
3586	def __init__(self, isotropic: _api.Isotropic):
3587		self._Entity = isotropic
3588
3589	@property
3590	def MaterialFamilyName(self) -> str:
3591		return self._Entity.MaterialFamilyName
3592
3593	@property
3594	def Id(self) -> int:
3595		return self._Entity.Id
3596
3597	@property
3598	def CreationDate(self) -> DateTime:
3599		return self._Entity.CreationDate
3600
3601	@property
3602	def ModificationDate(self) -> DateTime:
3603		return self._Entity.ModificationDate
3604
3605	@property
3606	def Name(self) -> str:
3607		return self._Entity.Name
3608
3609	@property
3610	def Form(self) -> str:
3611		return self._Entity.Form
3612
3613	@property
3614	def Specification(self) -> str:
3615		return self._Entity.Specification
3616
3617	@property
3618	def Temper(self) -> str:
3619		return self._Entity.Temper
3620
3621	@property
3622	def Basis(self) -> str:
3623		return self._Entity.Basis
3624
3625	@property
3626	def Density(self) -> float:
3627		return self._Entity.Density
3628
3629	@property
3630	def MaterialDescription(self) -> str:
3631		return self._Entity.MaterialDescription
3632
3633	@property
3634	def UserNote(self) -> str:
3635		return self._Entity.UserNote
3636
3637	@property
3638	def FemMaterialId(self) -> int:
3639		return self._Entity.FemMaterialId
3640
3641	@property
3642	def Cost(self) -> float:
3643		return self._Entity.Cost
3644
3645	@property
3646	def BucklingStiffnessKnockdown(self) -> float:
3647		return self._Entity.BucklingStiffnessKnockdown
3648
3649	@property
3650	def IsotropicTemperatureProperties(self) -> list[IsotropicTemperature]:
3651		return [IsotropicTemperature(isotropicTemperature) for isotropicTemperature in self._Entity.IsotropicTemperatureProperties]
3652
3653	@MaterialFamilyName.setter
3654	def MaterialFamilyName(self, value: str) -> None:
3655		self._Entity.MaterialFamilyName = value
3656
3657	@Name.setter
3658	def Name(self, value: str) -> None:
3659		self._Entity.Name = value
3660
3661	@Form.setter
3662	def Form(self, value: str) -> None:
3663		self._Entity.Form = value
3664
3665	@Specification.setter
3666	def Specification(self, value: str) -> None:
3667		self._Entity.Specification = value
3668
3669	@Temper.setter
3670	def Temper(self, value: str) -> None:
3671		self._Entity.Temper = value
3672
3673	@Basis.setter
3674	def Basis(self, value: str) -> None:
3675		self._Entity.Basis = value
3676
3677	@Density.setter
3678	def Density(self, value: float) -> None:
3679		self._Entity.Density = value
3680
3681	@MaterialDescription.setter
3682	def MaterialDescription(self, value: str) -> None:
3683		self._Entity.MaterialDescription = value
3684
3685	@UserNote.setter
3686	def UserNote(self, value: str) -> None:
3687		self._Entity.UserNote = value
3688
3689	@FemMaterialId.setter
3690	def FemMaterialId(self, value: int) -> None:
3691		self._Entity.FemMaterialId = value
3692
3693	@Cost.setter
3694	def Cost(self, value: float) -> None:
3695		self._Entity.Cost = value
3696
3697	@BucklingStiffnessKnockdown.setter
3698	def BucklingStiffnessKnockdown(self, value: float) -> None:
3699		self._Entity.BucklingStiffnessKnockdown = value
3700
3701	def AddTemperatureProperty(self, temperature: float, et: float, ec: float, g: float, ftuL: float, ftyL: float, fcyL: float, ftuLT: float, ftyLT: float, fcyLT: float, fsu: float, alpha: float, n: float = None, f02: float = None, k: float = None, c: float = None, fbru15: float = None, fbry15: float = None, fbru20: float = None, fbry20: float = None, etyL: float = None, ecyL: float = None, etyLT: float = None, ecyLT: float = None, esu: float = None, fpadh: float = None, fsadh: float = None, esadh: float = None, cd: float = None, ffwt: float = None, ffxz: float = None, ffyz: float = None, ftFatigue: float = None, fcFatigue: float = None) -> IsotropicTemperature:
3702		return IsotropicTemperature(self._Entity.AddTemperatureProperty(temperature, et, ec, g, ftuL, ftyL, fcyL, ftuLT, ftyLT, fcyLT, fsu, alpha, n, f02, k, c, fbru15, fbry15, fbru20, fbry20, etyL, ecyL, etyLT, ecyLT, esu, fpadh, fsadh, esadh, cd, ffwt, ffxz, ffyz, ftFatigue, fcFatigue))
3703
3704	def DeleteTemperatureProperty(self, temperature: float) -> bool:
3705		return self._Entity.DeleteTemperatureProperty(temperature)
3706
3707	def GetTemperature(self, lookupTemperature: float) -> IsotropicTemperature:
3708		return IsotropicTemperature(self._Entity.GetTemperature(lookupTemperature))
3709
3710	def Save(self) -> None:
3711		'''
3712		Save any changes to this isotropic material to the database.
3713		'''
3714		return self._Entity.Save()
3715
3716
3717class LaminateBase(ABC):
3718	def __init__(self, laminateBase: _api.LaminateBase):
3719		self._Entity = laminateBase
3720
3721	@property
3722	def Id(self) -> int:
3723		return self._Entity.Id
3724
3725	@property
3726	def Name(self) -> str:
3727		return self._Entity.Name
3728
3729	@property
3730	def IsEditable(self) -> bool:
3731		return self._Entity.IsEditable
3732
3733	@property
3734	def MaterialFamilyName(self) -> str:
3735		return self._Entity.MaterialFamilyName
3736
3737	@property
3738	def LayerCount(self) -> int:
3739		return self._Entity.LayerCount
3740
3741	@property
3742	def Density(self) -> float:
3743		return self._Entity.Density
3744
3745	@property
3746	def Thickness(self) -> float:
3747		return self._Entity.Thickness
3748
3749	@property
3750	def LaminateFamilyId(self) -> int:
3751		return self._Entity.LaminateFamilyId
3752
3753	@property
3754	def LaminateFamilyOrder(self) -> int:
3755		return self._Entity.LaminateFamilyOrder
3756
3757	@property
3758	def HyperLaminate(self) -> bool:
3759		return self._Entity.HyperLaminate
3760
3761	@Name.setter
3762	def Name(self, value: str) -> None:
3763		self._Entity.Name = value
3764
3765	@MaterialFamilyName.setter
3766	def MaterialFamilyName(self, value: str) -> None:
3767		self._Entity.MaterialFamilyName = value
3768
3769	@abstractmethod
3770	def Save(self) -> None:
3771		'''
3772		Save the laminate.
3773		'''
3774		return self._Entity.Save()
3775
3776
3777class LaminateFamily(IdNameEntity):
3778	def __init__(self, laminateFamily: _api.LaminateFamily):
3779		self._Entity = laminateFamily
3780
3781	@property
3782	def Laminates(self) -> list[LaminateBase]:
3783		return [LaminateBase(laminateBase) for laminateBase in self._Entity.Laminates]
3784
3785	@property
3786	def ModificationDate(self) -> DateTime:
3787		return self._Entity.ModificationDate
3788
3789	@property
3790	def PlankSetting(self) -> types.LaminateFamilySettingType:
3791		return types.LaminateFamilySettingType[self._Entity.PlankSetting.ToString()]
3792
3793	@property
3794	def PlankMinRatio(self) -> float:
3795		return self._Entity.PlankMinRatio
3796
3797	@property
3798	def PlankMaxRatio(self) -> float:
3799		return self._Entity.PlankMaxRatio
3800
3801	@property
3802	def FootChargeSetting(self) -> types.LaminateFamilySettingType:
3803		return types.LaminateFamilySettingType[self._Entity.FootChargeSetting.ToString()]
3804
3805	@property
3806	def FootChargeMinRatio(self) -> float:
3807		return self._Entity.FootChargeMinRatio
3808
3809	@property
3810	def FootChargeMaxRatio(self) -> float:
3811		return self._Entity.FootChargeMaxRatio
3812
3813	@property
3814	def WebChargeSetting(self) -> types.LaminateFamilySettingType:
3815		return types.LaminateFamilySettingType[self._Entity.WebChargeSetting.ToString()]
3816
3817	@property
3818	def WebChargeMinRatio(self) -> float:
3819		return self._Entity.WebChargeMinRatio
3820
3821	@property
3822	def WebChargeMaxRatio(self) -> float:
3823		return self._Entity.WebChargeMaxRatio
3824
3825	@property
3826	def CapChargeSetting(self) -> types.LaminateFamilySettingType:
3827		return types.LaminateFamilySettingType[self._Entity.CapChargeSetting.ToString()]
3828
3829	@property
3830	def CapChargeMinRatio(self) -> float:
3831		return self._Entity.CapChargeMinRatio
3832
3833	@property
3834	def CapChargeMaxRatio(self) -> float:
3835		return self._Entity.CapChargeMaxRatio
3836
3837	@property
3838	def CapCoverSetting(self) -> types.LaminateFamilySettingType:
3839		return types.LaminateFamilySettingType[self._Entity.CapCoverSetting.ToString()]
3840
3841	@property
3842	def CapCoverMinRatio(self) -> float:
3843		return self._Entity.CapCoverMinRatio
3844
3845	@property
3846	def CapCoverMaxRatio(self) -> float:
3847		return self._Entity.CapCoverMaxRatio
3848
3849	@property
3850	def DropPattern(self) -> types.PlyDropPattern:
3851		return types.PlyDropPattern[self._Entity.DropPattern.ToString()]
3852
3853	@property
3854	def LaminateStiffenerProfile(self) -> types.StiffenerProfile:
3855		return types.StiffenerProfile[self._Entity.LaminateStiffenerProfile.ToString()]
3856
3857
3858class LaminateLayerBase(ABC):
3859	def __init__(self, laminateLayerBase: _api.LaminateLayerBase):
3860		self._Entity = laminateLayerBase
3861
3862	@property
3863	def LayerId(self) -> int:
3864		return self._Entity.LayerId
3865
3866	@property
3867	def LayerMaterial(self) -> str:
3868		return self._Entity.LayerMaterial
3869
3870	@property
3871	def LayerMaterialType(self) -> types.MaterialType:
3872		'''
3873		Represents a material's type.
3874		'''
3875		return types.MaterialType[self._Entity.LayerMaterialType.ToString()]
3876
3877	@property
3878	def Angle(self) -> float:
3879		return self._Entity.Angle
3880
3881	@property
3882	def Thickness(self) -> float:
3883		return self._Entity.Thickness
3884
3885	@property
3886	def IsFabric(self) -> bool:
3887		return self._Entity.IsFabric
3888
3889	@Angle.setter
3890	@abstractmethod
3891	def Angle(self, value: float) -> None:
3892		self._Entity.Angle = value
3893
3894	def SetThickness(self, thickness: float) -> None:
3895		return self._Entity.SetThickness(thickness)
3896
3897	@overload
3898	def SetMaterial(self, matId: int) -> bool: ...
3899
3900	@overload
3901	def SetMaterial(self, matName: str) -> bool: ...
3902
3903	def SetMaterial(self, item1 = None) -> bool:
3904		if isinstance(item1, int):
3905			return self._Entity.SetMaterial(item1)
3906
3907		if isinstance(item1, str):
3908			return self._Entity.SetMaterial(item1)
3909
3910		return self._Entity.SetMaterial(item1)
3911
3912
3913class LaminateLayer(LaminateLayerBase):
3914	'''
3915	Layer in a non-stiffener laminate.
3916	'''
3917	def __init__(self, laminateLayer: _api.LaminateLayer):
3918		self._Entity = laminateLayer
3919
3920	@property
3921	def LayerId(self) -> int:
3922		return self._Entity.LayerId
3923
3924	@property
3925	def LayerMaterialType(self) -> types.MaterialType:
3926		'''
3927		Represents a material's type.
3928		'''
3929		return types.MaterialType[self._Entity.LayerMaterialType.ToString()]
3930
3931	@property
3932	def Angle(self) -> float:
3933		return self._Entity.Angle
3934
3935	@property
3936	def Thickness(self) -> float:
3937		return self._Entity.Thickness
3938
3939	@property
3940	def IsFabric(self) -> bool:
3941		return self._Entity.IsFabric
3942
3943	@Angle.setter
3944	def Angle(self, value: float) -> None:
3945		self._Entity.Angle = value
3946
3947	@overload
3948	def SetMaterial(self, matId: int) -> bool: ...
3949
3950	@overload
3951	def SetMaterial(self, matName: str) -> bool: ...
3952
3953	def SetMaterial(self, item1 = None) -> bool:
3954		if isinstance(item1, int):
3955			return bool(super().SetMaterial(item1))
3956
3957		if isinstance(item1, str):
3958			return bool(super().SetMaterial(item1))
3959
3960		return self._Entity.SetMaterial(item1)
3961
3962
3963class Laminate(LaminateBase):
3964	'''
3965	Laminate
3966	'''
3967	def __init__(self, laminate: _api.Laminate):
3968		self._Entity = laminate
3969
3970	@property
3971	def Layers(self) -> list[LaminateLayer]:
3972		return [LaminateLayer(laminateLayer) for laminateLayer in self._Entity.Layers]
3973
3974	def AddLayer(self, materialName: str, angle: float, thickness: float = None) -> LaminateLayer:
3975		return LaminateLayer(self._Entity.AddLayer(materialName, angle, thickness))
3976
3977	def InsertLayer(self, layerId: int, materialName: str, angle: float, thickness: float = None) -> LaminateLayer:
3978		return LaminateLayer(self._Entity.InsertLayer(layerId, materialName, angle, thickness))
3979
3980	def RemoveLayer(self, layerId: int) -> bool:
3981		return self._Entity.RemoveLayer(layerId)
3982
3983	def Save(self) -> None:
3984		'''
3985		Save any changes to this laminate material to the database.
3986		'''
3987		return self._Entity.Save()
3988
3989
3990class StiffenerLaminateLayer(LaminateLayerBase):
3991	'''
3992	Stiffener Laminate Layer
3993	'''
3994	def __init__(self, stiffenerLaminateLayer: _api.StiffenerLaminateLayer):
3995		self._Entity = stiffenerLaminateLayer
3996
3997	@property
3998	def LayerLocations(self) -> list[types.StiffenerLaminateLayerLocation]:
3999		return [types.StiffenerLaminateLayerLocation[stiffenerLaminateLayerLocation.ToString()] for stiffenerLaminateLayerLocation in self._Entity.LayerLocations]
4000
4001	@property
4002	def LayerId(self) -> int:
4003		return self._Entity.LayerId
4004
4005	@property
4006	def LayerMaterialType(self) -> types.MaterialType:
4007		'''
4008		Represents a material's type.
4009		'''
4010		return types.MaterialType[self._Entity.LayerMaterialType.ToString()]
4011
4012	@property
4013	def Angle(self) -> float:
4014		return self._Entity.Angle
4015
4016	@property
4017	def Thickness(self) -> float:
4018		return self._Entity.Thickness
4019
4020	@property
4021	def IsFabric(self) -> bool:
4022		return self._Entity.IsFabric
4023
4024	@Angle.setter
4025	def Angle(self, value: float) -> None:
4026		self._Entity.Angle = value
4027
4028	def AddLayerLocation(self, location: types.StiffenerLaminateLayerLocation) -> None:
4029		return self._Entity.AddLayerLocation(_types.StiffenerLaminateLayerLocation(location.value))
4030
4031	def RemoveLayerLocation(self, location: types.StiffenerLaminateLayerLocation) -> bool:
4032		return self._Entity.RemoveLayerLocation(_types.StiffenerLaminateLayerLocation(location.value))
4033
4034	@overload
4035	def SetMaterial(self, matId: int) -> bool: ...
4036
4037	@overload
4038	def SetMaterial(self, matName: str) -> bool: ...
4039
4040	def SetMaterial(self, item1 = None) -> bool:
4041		if isinstance(item1, int):
4042			return bool(super().SetMaterial(item1))
4043
4044		if isinstance(item1, str):
4045			return bool(super().SetMaterial(item1))
4046
4047		return self._Entity.SetMaterial(item1)
4048
4049
4050class StiffenerLaminate(LaminateBase):
4051	'''
4052	Stiffener Laminate
4053	'''
4054	def __init__(self, stiffenerLaminate: _api.StiffenerLaminate):
4055		self._Entity = stiffenerLaminate
4056
4057	@property
4058	def Layers(self) -> list[StiffenerLaminateLayer]:
4059		return [StiffenerLaminateLayer(stiffenerLaminateLayer) for stiffenerLaminateLayer in self._Entity.Layers]
4060
4061	@property
4062	def LaminateStiffenerProfile(self) -> types.StiffenerProfile:
4063		return types.StiffenerProfile[self._Entity.LaminateStiffenerProfile.ToString()]
4064
4065	@overload
4066	def AddLayer(self, location: types.StiffenerLaminateLayerLocation, materialName: str, angle: float, thickness: float = None) -> StiffenerLaminateLayer: ...
4067
4068	@overload
4069	def InsertLayer(self, location: types.StiffenerLaminateLayerLocation, layerId: int, materialName: str, angle: float, thickness: float = None) -> StiffenerLaminateLayer: ...
4070
4071	@overload
4072	def AddLayer(self, locations: tuple[types.StiffenerLaminateLayerLocation], materialName: str, angle: float, thickness: float = None) -> StiffenerLaminateLayer: ...
4073
4074	@overload
4075	def InsertLayer(self, locations: tuple[types.StiffenerLaminateLayerLocation], layerId: int, materialName: str, angle: float, thickness: float = None) -> StiffenerLaminateLayer: ...
4076
4077	def RemoveLayer(self, layerId: int) -> bool:
4078		return self._Entity.RemoveLayer(layerId)
4079
4080	def Save(self) -> None:
4081		'''
4082		Save laminate to database.
4083		'''
4084		return self._Entity.Save()
4085
4086	def AddLayer(self, item1 = None, item2 = None, item3 = None, item4 = None) -> StiffenerLaminateLayer:
4087		if isinstance(item1, types.StiffenerLaminateLayerLocation) and isinstance(item2, str) and isinstance(item3, float) and isinstance(item4, float):
4088			return StiffenerLaminateLayer(self._Entity.AddLayer(_types.StiffenerLaminateLayerLocation(item1.value), item2, item3, item4))
4089
4090		if isinstance(item1, tuple) and item1 and isinstance(item1[0], types.StiffenerLaminateLayerLocation) and isinstance(item2, str) and isinstance(item3, float) and isinstance(item4, float):
4091			locationsList = List[_types.StiffenerLaminateLayerLocation]()
4092			if item1 is not None:
4093				for thing in item1:
4094					if thing is not None:
4095						locationsList.Add(_types.StiffenerLaminateLayerLocation(thing.value))
4096			locationsEnumerable = IEnumerable(locationsList)
4097			return StiffenerLaminateLayer(self._Entity.AddLayer(locationsEnumerable, item2, item3, item4))
4098
4099		return StiffenerLaminateLayer(self._Entity.AddLayer(_types.StiffenerLaminateLayerLocation(item1.value), item2, item3, item4))
4100
4101	def InsertLayer(self, item1 = None, item2 = None, item3 = None, item4 = None, item5 = None) -> StiffenerLaminateLayer:
4102		if isinstance(item1, types.StiffenerLaminateLayerLocation) and isinstance(item2, int) and isinstance(item3, str) and isinstance(item4, float) and isinstance(item5, float):
4103			return StiffenerLaminateLayer(self._Entity.InsertLayer(_types.StiffenerLaminateLayerLocation(item1.value), item2, item3, item4, item5))
4104
4105		if isinstance(item1, tuple) and item1 and isinstance(item1[0], types.StiffenerLaminateLayerLocation) and isinstance(item2, int) and isinstance(item3, str) and isinstance(item4, float) and isinstance(item5, float):
4106			locationsList = List[_types.StiffenerLaminateLayerLocation]()
4107			if item1 is not None:
4108				for thing in item1:
4109					if thing is not None:
4110						locationsList.Add(_types.StiffenerLaminateLayerLocation(thing.value))
4111			locationsEnumerable = IEnumerable(locationsList)
4112			return StiffenerLaminateLayer(self._Entity.InsertLayer(locationsEnumerable, item2, item3, item4, item5))
4113
4114		return StiffenerLaminateLayer(self._Entity.InsertLayer(_types.StiffenerLaminateLayerLocation(item1.value), item2, item3, item4, item5))
4115
4116
4117class OrthotropicCorrectionFactorBase(ABC):
4118	'''
4119	Orthotropic material correction factor.
4120	'''
4121	def __init__(self, orthotropicCorrectionFactorBase: _api.OrthotropicCorrectionFactorBase):
4122		self._Entity = orthotropicCorrectionFactorBase
4123
4124	@property
4125	def CorrectionId(self) -> types.CorrectionId:
4126		'''
4127		Correction ID for a correction factor. (Columns in HyperX)
4128		'''
4129		return types.CorrectionId[self._Entity.CorrectionId.ToString()]
4130
4131	@property
4132	def PropertyId(self) -> types.CorrectionProperty:
4133		'''
4134		Property name for a correction factor. (Rows in HyperX)
4135		'''
4136		return types.CorrectionProperty[self._Entity.PropertyId.ToString()]
4137
4138
4139class OrthotropicCorrectionFactorPoint:
4140	'''
4141	Pointer to an Equation-based or Tabular Correction Factor.
4142	'''
4143	def __init__(self, orthotropicCorrectionFactorPoint: _api.OrthotropicCorrectionFactorPoint):
4144		self._Entity = orthotropicCorrectionFactorPoint
4145
4146	def Create_OrthotropicCorrectionFactorPoint(property: types.CorrectionProperty, id: types.CorrectionId):
4147		return OrthotropicCorrectionFactorPoint(_api.OrthotropicCorrectionFactorPoint(_types.CorrectionProperty(property.value), _types.CorrectionId(id.value)))
4148
4149	@property
4150	def CorrectionProperty(self) -> types.CorrectionProperty:
4151		'''
4152		Property name for a correction factor. (Rows in HyperX)
4153		'''
4154		return types.CorrectionProperty[self._Entity.CorrectionProperty.ToString()]
4155
4156	@property
4157	def CorrectionId(self) -> types.CorrectionId:
4158		'''
4159		Correction ID for a correction factor. (Columns in HyperX)
4160		'''
4161		return types.CorrectionId[self._Entity.CorrectionId.ToString()]
4162
4163	@overload
4164	def Equals(self, other) -> bool: ...
4165
4166	@overload
4167	def Equals(self, obj) -> bool: ...
4168
4169	def GetHashCode(self) -> int:
4170		return self._Entity.GetHashCode()
4171
4172	def Equals(self, item1 = None) -> bool:
4173		if isinstance(item1, OrthotropicCorrectionFactorPoint):
4174			return self._Entity.Equals(item1._Entity)
4175
4176		return self._Entity.Equals(item1._Entity)
4177
4178
4179class OrthotropicCorrectionFactorValue:
4180	'''
4181	Orthotropic material equation-based correction factor value. (NOT TABULAR)
4182	'''
4183	def __init__(self, orthotropicCorrectionFactorValue: _api.OrthotropicCorrectionFactorValue):
4184		self._Entity = orthotropicCorrectionFactorValue
4185
4186	@property
4187	def Property(self) -> types.CorrectionProperty:
4188		'''
4189		Property name for a correction factor. (Rows in HyperX)
4190		'''
4191		return types.CorrectionProperty[self._Entity.Property.ToString()]
4192
4193	@property
4194	def Correction(self) -> types.CorrectionId:
4195		'''
4196		Correction ID for a correction factor. (Columns in HyperX)
4197		'''
4198		return types.CorrectionId[self._Entity.Correction.ToString()]
4199
4200	@property
4201	def Equation(self) -> types.CorrectionEquation:
4202		'''
4203		Equation for a correction factor.
4204		'''
4205		return types.CorrectionEquation[self._Entity.Equation.ToString()]
4206
4207	@property
4208	def EquationParameter(self) -> types.EquationParameterId:
4209		'''
4210		Correction factor parameter names.
4211		'''
4212		return types.EquationParameterId[self._Entity.EquationParameter.ToString()]
4213
4214	@property
4215	def Value(self) -> float:
4216		return self._Entity.Value
4217
4218	@Value.setter
4219	def Value(self, value: float) -> None:
4220		self._Entity.Value = value
4221
4222
4223class OrthotropicEquationCorrectionFactor(OrthotropicCorrectionFactorBase):
4224	'''
4225	Represents an equation-based orthotropic material correction factor.
4226	'''
4227	def __init__(self, orthotropicEquationCorrectionFactor: _api.OrthotropicEquationCorrectionFactor):
4228		self._Entity = orthotropicEquationCorrectionFactor
4229
4230	@property
4231	def Equation(self) -> types.CorrectionEquation:
4232		'''
4233		Equation for a correction factor.
4234		'''
4235		return types.CorrectionEquation[self._Entity.Equation.ToString()]
4236
4237	@property
4238	def OrthotropicCorrectionValues(self) -> dict[types.EquationParameterId, OrthotropicCorrectionFactorValue]:
4239		orthotropicCorrectionValuesDict = {}
4240		for kvp in self._Entity.OrthotropicCorrectionValues:
4241			orthotropicCorrectionValuesDict[types.EquationParameterId[kvp.Key.ToString()]] = OrthotropicCorrectionFactorValue(kvp.Value)
4242
4243		return orthotropicCorrectionValuesDict
4244
4245	def AddCorrectionFactorValue(self, equationParameterName: types.EquationParameterId, valueToAdd: float) -> OrthotropicCorrectionFactorValue:
4246		return OrthotropicCorrectionFactorValue(self._Entity.AddCorrectionFactorValue(_types.EquationParameterId(equationParameterName.value), valueToAdd))
4247
4248
4249class TabularCorrectionFactorIndependentValue:
4250	'''
4251	Contains an independent value for a tabular correction factor row.
4252	'''
4253	def __init__(self, tabularCorrectionFactorIndependentValue: _api.TabularCorrectionFactorIndependentValue):
4254		self._Entity = tabularCorrectionFactorIndependentValue
4255
4256	@property
4257	def BoolValue(self) -> bool:
4258		return self._Entity.BoolValue
4259
4260	@property
4261	def DoubleValue(self) -> float:
4262		return self._Entity.DoubleValue
4263
4264	@property
4265	def IntValue(self) -> int:
4266		return self._Entity.IntValue
4267
4268	@property
4269	def ValueType(self) -> types.CorrectionValueType:
4270		'''
4271		Defines the type of the independent values on a tabular correction factor row.
4272		'''
4273		return types.CorrectionValueType[self._Entity.ValueType.ToString()]
4274
4275
4276class TabularCorrectionFactorRow:
4277	'''
4278	Row data for a tabular correction factor.
4279	'''
4280	def __init__(self, tabularCorrectionFactorRow: _api.TabularCorrectionFactorRow):
4281		self._Entity = tabularCorrectionFactorRow
4282
4283	@property
4284	def DependentValue(self) -> float:
4285		return self._Entity.DependentValue
4286
4287	@property
4288	def IndependentValues(self) -> dict[types.CorrectionIndependentDefinition, TabularCorrectionFactorIndependentValue]:
4289		independentValuesDict = {}
4290		for kvp in self._Entity.IndependentValues:
4291			independentValuesDict[types.CorrectionIndependentDefinition[kvp.Key.ToString()]] = TabularCorrectionFactorIndependentValue(kvp.Value)
4292
4293		return independentValuesDict
4294
4295
4296class OrthotropicTabularCorrectionFactor(OrthotropicCorrectionFactorBase):
4297	'''
4298	Tabular correction factor.
4299	'''
4300	def __init__(self, orthotropicTabularCorrectionFactor: _api.OrthotropicTabularCorrectionFactor):
4301		self._Entity = orthotropicTabularCorrectionFactor
4302
4303	@property
4304	def CorrectionFactorRows(self) -> dict[int, TabularCorrectionFactorRow]:
4305		correctionFactorRowsDict = {}
4306		for kvp in self._Entity.CorrectionFactorRows:
4307			correctionFactorRowsDict[int(kvp.Key)] = TabularCorrectionFactorRow(kvp.Value)
4308
4309		return correctionFactorRowsDict
4310
4311	@property
4312	def CorrectionIndependentDefinitions(self) -> set[types.CorrectionIndependentDefinition]:
4313		return {types.CorrectionIndependentDefinition(correctionIndependentDefinition) for correctionIndependentDefinition in self._Entity.CorrectionIndependentDefinitions}
4314
4315	@overload
4316	def SetIndependentValue(self, correctionPointId: int, cid: types.CorrectionIndependentDefinition, value: float) -> None: ...
4317
4318	@overload
4319	def SetIndependentValue(self, correctionPointId: int, cid: types.CorrectionIndependentDefinition, value: bool) -> None: ...
4320
4321	@overload
4322	def SetIndependentValue(self, correctionPointId: int, cid: types.CorrectionIndependentDefinition, value: int) -> None: ...
4323
4324	def SetKValue(self, correctionPointId: int, value: float) -> None:
4325		return self._Entity.SetKValue(correctionPointId, value)
4326
4327	def SetIndependentValue(self, item1 = None, item2 = None, item3 = None) -> None:
4328		if isinstance(item1, int) and isinstance(item2, types.CorrectionIndependentDefinition) and isinstance(item3, float):
4329			return self._Entity.SetIndependentValue(item1, _types.CorrectionIndependentDefinition(item2.value), item3)
4330
4331		if isinstance(item1, int) and isinstance(item2, types.CorrectionIndependentDefinition) and isinstance(item3, bool):
4332			return self._Entity.SetIndependentValue(item1, _types.CorrectionIndependentDefinition(item2.value), item3)
4333
4334		if isinstance(item1, int) and isinstance(item2, types.CorrectionIndependentDefinition) and isinstance(item3, int):
4335			return self._Entity.SetIndependentValue(item1, _types.CorrectionIndependentDefinition(item2.value), item3)
4336
4337		return self._Entity.SetIndependentValue(item1, _types.CorrectionIndependentDefinition(item2.value), item3)
4338
4339
4340class OrthotropicAllowableCurvePoint:
4341	'''
4342	Represents a point on a laminate allowable curve.
4343	'''
4344	def __init__(self, orthotropicAllowableCurvePoint: _api.OrthotropicAllowableCurvePoint):
4345		self._Entity = orthotropicAllowableCurvePoint
4346
4347	@property
4348	def Property_ID(self) -> types.AllowablePropertyName:
4349		'''
4350		Property name for a laminate allowable.
4351		'''
4352		return types.AllowablePropertyName[self._Entity.Property_ID.ToString()]
4353
4354	@property
4355	def Temperature(self) -> float:
4356		return self._Entity.Temperature
4357
4358	@property
4359	def X(self) -> float:
4360		return self._Entity.X
4361
4362	@property
4363	def Y(self) -> float:
4364		return self._Entity.Y
4365
4366	@Property_ID.setter
4367	def Property_ID(self, value: types.AllowablePropertyName) -> None:
4368		self._Entity.Property_ID = _types.AllowablePropertyName(value.value)
4369
4370	@Temperature.setter
4371	def Temperature(self, value: float) -> None:
4372		self._Entity.Temperature = value
4373
4374	@X.setter
4375	def X(self, value: float) -> None:
4376		self._Entity.X = value
4377
4378	@Y.setter
4379	def Y(self, value: float) -> None:
4380		self._Entity.Y = value
4381
4382
4383class OrthotropicEffectiveLaminate:
4384	'''
4385	Orthotropic material effective laminate properties. Read-only from the API.
4386            Check if material is an effective laminate with orthotropic.IsEffectiveLaminate.
4387	'''
4388	def __init__(self, orthotropicEffectiveLaminate: _api.OrthotropicEffectiveLaminate):
4389		self._Entity = orthotropicEffectiveLaminate
4390
4391	@property
4392	def Percent_tape_0(self) -> float:
4393		return self._Entity.Percent_tape_0
4394
4395	@property
4396	def Percent_tape_90(self) -> float:
4397		return self._Entity.Percent_tape_90
4398
4399	@property
4400	def Percent_tape_45(self) -> float:
4401		return self._Entity.Percent_tape_45
4402
4403	@property
4404	def Percent_fabric_0(self) -> float:
4405		return self._Entity.Percent_fabric_0
4406
4407	@property
4408	def Percent_fabric_90(self) -> float:
4409		return self._Entity.Percent_fabric_90
4410
4411	@property
4412	def Percent_fabric_45(self) -> float:
4413		return self._Entity.Percent_fabric_45
4414
4415	@property
4416	def Tape_Orthotropic(self) -> str:
4417		return self._Entity.Tape_Orthotropic
4418
4419	@property
4420	def Fabric_Orthotropic(self) -> str:
4421		return self._Entity.Fabric_Orthotropic
4422
4423	@property
4424	def Valid(self) -> bool:
4425		return self._Entity.Valid
4426
4427	@property
4428	def Use_tape_allowables(self) -> bool:
4429		return self._Entity.Use_tape_allowables
4430
4431
4432class OrthotropicLaminateAllowable:
4433	'''
4434	Orthotropic material laminate allowable properties.
4435	'''
4436	def __init__(self, orthotropicLaminateAllowable: _api.OrthotropicLaminateAllowable):
4437		self._Entity = orthotropicLaminateAllowable
4438
4439	@property
4440	def Property_ID(self) -> types.AllowablePropertyName:
4441		'''
4442		Property name for a laminate allowable.
4443		'''
4444		return types.AllowablePropertyName[self._Entity.Property_ID.ToString()]
4445
4446	@property
4447	def Method_ID(self) -> types.AllowableMethodName:
4448		'''
4449		Method name for a laminate allowable.
4450		'''
4451		return types.AllowableMethodName[self._Entity.Method_ID.ToString()]
4452
4453	@Property_ID.setter
4454	def Property_ID(self, value: types.AllowablePropertyName) -> None:
4455		self._Entity.Property_ID = _types.AllowablePropertyName(value.value)
4456
4457	@Method_ID.setter
4458	def Method_ID(self, value: types.AllowableMethodName) -> None:
4459		self._Entity.Method_ID = _types.AllowableMethodName(value.value)
4460
4461
4462class OrthotropicTemperature:
4463	'''
4464	Orthotropic material temperature dependent properties.
4465	'''
4466	def __init__(self, orthotropicTemperature: _api.OrthotropicTemperature):
4467		self._Entity = orthotropicTemperature
4468
4469	@property
4470	def Temperature(self) -> float:
4471		return self._Entity.Temperature
4472
4473	@property
4474	def Et1(self) -> float:
4475		return self._Entity.Et1
4476
4477	@property
4478	def Et2(self) -> float:
4479		return self._Entity.Et2
4480
4481	@property
4482	def vt12(self) -> float:
4483		return self._Entity.vt12
4484
4485	@property
4486	def Ec1(self) -> float:
4487		return self._Entity.Ec1
4488
4489	@property
4490	def Ec2(self) -> float:
4491		return self._Entity.Ec2
4492
4493	@property
4494	def vc12(self) -> float:
4495		return self._Entity.vc12
4496
4497	@property
4498	def G12(self) -> float:
4499		return self._Entity.G12
4500
4501	@property
4502	def G13(self) -> float:
4503		return self._Entity.G13
4504
4505	@property
4506	def G23(self) -> float:
4507		return self._Entity.G23
4508
4509	@property
4510	def Ftu1(self) -> float:
4511		return self._Entity.Ftu1
4512
4513	@property
4514	def Ftu2(self) -> float:
4515		return self._Entity.Ftu2
4516
4517	@property
4518	def Fcu1(self) -> float:
4519		return self._Entity.Fcu1
4520
4521	@property
4522	def Fcu2(self) -> float:
4523		return self._Entity.Fcu2
4524
4525	@property
4526	def Fsu12(self) -> float:
4527		return self._Entity.Fsu12
4528
4529	@property
4530	def Fsu13(self) -> float:
4531		return self._Entity.Fsu13
4532
4533	@property
4534	def Fsu23(self) -> float:
4535		return self._Entity.Fsu23
4536
4537	@property
4538	def GIc(self) -> float:
4539		return self._Entity.GIc
4540
4541	@property
4542	def alpha1(self) -> float:
4543		return self._Entity.alpha1
4544
4545	@property
4546	def alpha2(self) -> float:
4547		return self._Entity.alpha2
4548
4549	@property
4550	def K1(self) -> float:
4551		return self._Entity.K1
4552
4553	@property
4554	def K2(self) -> float:
4555		return self._Entity.K2
4556
4557	@property
4558	def C(self) -> float:
4559		return self._Entity.C
4560
4561	@property
4562	def etu1(self) -> float:
4563		return self._Entity.etu1
4564
4565	@property
4566	def etu2(self) -> float:
4567		return self._Entity.etu2
4568
4569	@property
4570	def ecu1(self) -> float:
4571		return self._Entity.ecu1
4572
4573	@property
4574	def ecu2(self) -> float:
4575		return self._Entity.ecu2
4576
4577	@property
4578	def ecuoh(self) -> float:
4579		return self._Entity.ecuoh
4580
4581	@property
4582	def ecuai(self) -> float:
4583		return self._Entity.ecuai
4584
4585	@property
4586	def esu12(self) -> float:
4587		return self._Entity.esu12
4588
4589	@property
4590	def Ftu3(self) -> float:
4591		return self._Entity.Ftu3
4592
4593	@property
4594	def GIIc(self) -> float:
4595		return self._Entity.GIIc
4596
4597	@property
4598	def d0Tension(self) -> float:
4599		return self._Entity.d0Tension
4600
4601	@property
4602	def cd(self) -> float:
4603		return self._Entity.cd
4604
4605	@property
4606	def d0Compression(self) -> float:
4607		return self._Entity.d0Compression
4608
4609	@property
4610	def TLt(self) -> float:
4611		return self._Entity.TLt
4612
4613	@property
4614	def TLc(self) -> float:
4615		return self._Entity.TLc
4616
4617	@property
4618	def TTt(self) -> float:
4619		return self._Entity.TTt
4620
4621	@property
4622	def TTc(self) -> float:
4623		return self._Entity.TTc
4624
4625	@property
4626	def OrthotropicAllowableCurvePoints(self) -> list[OrthotropicAllowableCurvePoint]:
4627		return [OrthotropicAllowableCurvePoint(orthotropicAllowableCurvePoint) for orthotropicAllowableCurvePoint in self._Entity.OrthotropicAllowableCurvePoints]
4628
4629	@Temperature.setter
4630	def Temperature(self, value: float) -> None:
4631		self._Entity.Temperature = value
4632
4633	@Et1.setter
4634	def Et1(self, value: float) -> None:
4635		self._Entity.Et1 = value
4636
4637	@Et2.setter
4638	def Et2(self, value: float) -> None:
4639		self._Entity.Et2 = value
4640
4641	@vt12.setter
4642	def vt12(self, value: float) -> None:
4643		self._Entity.vt12 = value
4644
4645	@Ec1.setter
4646	def Ec1(self, value: float) -> None:
4647		self._Entity.Ec1 = value
4648
4649	@Ec2.setter
4650	def Ec2(self, value: float) -> None:
4651		self._Entity.Ec2 = value
4652
4653	@vc12.setter
4654	def vc12(self, value: float) -> None:
4655		self._Entity.vc12 = value
4656
4657	@G12.setter
4658	def G12(self, value: float) -> None:
4659		self._Entity.G12 = value
4660
4661	@G13.setter
4662	def G13(self, value: float) -> None:
4663		self._Entity.G13 = value
4664
4665	@G23.setter
4666	def G23(self, value: float) -> None:
4667		self._Entity.G23 = value
4668
4669	@Ftu1.setter
4670	def Ftu1(self, value: float) -> None:
4671		self._Entity.Ftu1 = value
4672
4673	@Ftu2.setter
4674	def Ftu2(self, value: float) -> None:
4675		self._Entity.Ftu2 = value
4676
4677	@Fcu1.setter
4678	def Fcu1(self, value: float) -> None:
4679		self._Entity.Fcu1 = value
4680
4681	@Fcu2.setter
4682	def Fcu2(self, value: float) -> None:
4683		self._Entity.Fcu2 = value
4684
4685	@Fsu12.setter
4686	def Fsu12(self, value: float) -> None:
4687		self._Entity.Fsu12 = value
4688
4689	@Fsu13.setter
4690	def Fsu13(self, value: float) -> None:
4691		self._Entity.Fsu13 = value
4692
4693	@Fsu23.setter
4694	def Fsu23(self, value: float) -> None:
4695		self._Entity.Fsu23 = value
4696
4697	@GIc.setter
4698	def GIc(self, value: float) -> None:
4699		self._Entity.GIc = value
4700
4701	@alpha1.setter
4702	def alpha1(self, value: float) -> None:
4703		self._Entity.alpha1 = value
4704
4705	@alpha2.setter
4706	def alpha2(self, value: float) -> None:
4707		self._Entity.alpha2 = value
4708
4709	@K1.setter
4710	def K1(self, value: float) -> None:
4711		self._Entity.K1 = value
4712
4713	@K2.setter
4714	def K2(self, value: float) -> None:
4715		self._Entity.K2 = value
4716
4717	@C.setter
4718	def C(self, value: float) -> None:
4719		self._Entity.C = value
4720
4721	@etu1.setter
4722	def etu1(self, value: float) -> None:
4723		self._Entity.etu1 = value
4724
4725	@etu2.setter
4726	def etu2(self, value: float) -> None:
4727		self._Entity.etu2 = value
4728
4729	@ecu1.setter
4730	def ecu1(self, value: float) -> None:
4731		self._Entity.ecu1 = value
4732
4733	@ecu2.setter
4734	def ecu2(self, value: float) -> None:
4735		self._Entity.ecu2 = value
4736
4737	@ecuoh.setter
4738	def ecuoh(self, value: float) -> None:
4739		self._Entity.ecuoh = value
4740
4741	@ecuai.setter
4742	def ecuai(self, value: float) -> None:
4743		self._Entity.ecuai = value
4744
4745	@esu12.setter
4746	def esu12(self, value: float) -> None:
4747		self._Entity.esu12 = value
4748
4749	@Ftu3.setter
4750	def Ftu3(self, value: float) -> None:
4751		self._Entity.Ftu3 = value
4752
4753	@GIIc.setter
4754	def GIIc(self, value: float) -> None:
4755		self._Entity.GIIc = value
4756
4757	@d0Tension.setter
4758	def d0Tension(self, value: float) -> None:
4759		self._Entity.d0Tension = value
4760
4761	@cd.setter
4762	def cd(self, value: float) -> None:
4763		self._Entity.cd = value
4764
4765	@d0Compression.setter
4766	def d0Compression(self, value: float) -> None:
4767		self._Entity.d0Compression = value
4768
4769	@TLt.setter
4770	def TLt(self, value: float) -> None:
4771		self._Entity.TLt = value
4772
4773	@TLc.setter
4774	def TLc(self, value: float) -> None:
4775		self._Entity.TLc = value
4776
4777	@TTt.setter
4778	def TTt(self, value: float) -> None:
4779		self._Entity.TTt = value
4780
4781	@TTc.setter
4782	def TTc(self, value: float) -> None:
4783		self._Entity.TTc = value
4784
4785	def AddCurvePoint(self, property: types.AllowablePropertyName, x: float, y: float) -> OrthotropicAllowableCurvePoint:
4786		return OrthotropicAllowableCurvePoint(self._Entity.AddCurvePoint(_types.AllowablePropertyName(property.value), x, y))
4787
4788	def DeleteCurvePoint(self, property: types.AllowablePropertyName, x: float) -> bool:
4789		return self._Entity.DeleteCurvePoint(_types.AllowablePropertyName(property.value), x)
4790
4791	def GetCurvePoint(self, property: types.AllowablePropertyName, x: float) -> OrthotropicAllowableCurvePoint:
4792		return OrthotropicAllowableCurvePoint(self._Entity.GetCurvePoint(_types.AllowablePropertyName(property.value), x))
4793
4794
4795class Orthotropic:
4796	'''
4797	Orthotropic material.
4798	'''
4799	def __init__(self, orthotropic: _api.Orthotropic):
4800		self._Entity = orthotropic
4801
4802	@property
4803	def MaterialFamilyName(self) -> str:
4804		return self._Entity.MaterialFamilyName
4805
4806	@property
4807	def Id(self) -> int:
4808		return self._Entity.Id
4809
4810	@property
4811	def CreationDate(self) -> DateTime:
4812		return self._Entity.CreationDate
4813
4814	@property
4815	def ModificationDate(self) -> DateTime:
4816		return self._Entity.ModificationDate
4817
4818	@property
4819	def Name(self) -> str:
4820		return self._Entity.Name
4821
4822	@property
4823	def Form(self) -> str:
4824		return self._Entity.Form
4825
4826	@property
4827	def Specification(self) -> str:
4828		return self._Entity.Specification
4829
4830	@property
4831	def Basis(self) -> str:
4832		return self._Entity.Basis
4833
4834	@property
4835	def Wet(self) -> bool:
4836		return self._Entity.Wet
4837
4838	@property
4839	def Thickness(self) -> float:
4840		return self._Entity.Thickness
4841
4842	@property
4843	def Density(self) -> float:
4844		return self._Entity.Density
4845
4846	@property
4847	def FiberVolume(self) -> float:
4848		return self._Entity.FiberVolume
4849
4850	@property
4851	def GlassTransition(self) -> float:
4852		return self._Entity.GlassTransition
4853
4854	@property
4855	def Manufacturer(self) -> str:
4856		return self._Entity.Manufacturer
4857
4858	@property
4859	def Processes(self) -> str:
4860		return self._Entity.Processes
4861
4862	@property
4863	def MaterialDescription(self) -> str:
4864		return self._Entity.MaterialDescription
4865
4866	@property
4867	def UserNote(self) -> str:
4868		return self._Entity.UserNote
4869
4870	@property
4871	def BendingCorrectionFactor(self) -> float:
4872		return self._Entity.BendingCorrectionFactor
4873
4874	@property
4875	def FemMaterialId(self) -> int:
4876		return self._Entity.FemMaterialId
4877
4878	@property
4879	def Cost(self) -> float:
4880		return self._Entity.Cost
4881
4882	@property
4883	def BucklingStiffnessKnockdown(self) -> float:
4884		return self._Entity.BucklingStiffnessKnockdown
4885
4886	@property
4887	def OrthotropicTemperatureProperties(self) -> list[OrthotropicTemperature]:
4888		return [OrthotropicTemperature(orthotropicTemperature) for orthotropicTemperature in self._Entity.OrthotropicTemperatureProperties]
4889
4890	@property
4891	def OrthotropicLaminateAllowables(self) -> list[OrthotropicLaminateAllowable]:
4892		return [OrthotropicLaminateAllowable(orthotropicLaminateAllowable) for orthotropicLaminateAllowable in self._Entity.OrthotropicLaminateAllowables]
4893
4894	@property
4895	def OrthotropicEffectiveLaminate(self) -> OrthotropicEffectiveLaminate:
4896		'''
4897		Orthotropic material effective laminate properties. Read-only from the API.
4898            Check if material is an effective laminate with orthotropic.IsEffectiveLaminate.
4899		'''
4900		result = self._Entity.OrthotropicEffectiveLaminate
4901		return OrthotropicEffectiveLaminate(result) if result is not None else None
4902
4903	@property
4904	def OrthotropicEquationCorrectionFactors(self) -> dict[OrthotropicCorrectionFactorPoint, OrthotropicEquationCorrectionFactor]:
4905		orthotropicEquationCorrectionFactorsDict = {}
4906		for kvp in self._Entity.OrthotropicEquationCorrectionFactors:
4907			orthotropicEquationCorrectionFactorsDict[OrthotropicCorrectionFactorPoint(kvp.Key)] = OrthotropicEquationCorrectionFactor(kvp.Value)
4908
4909		return orthotropicEquationCorrectionFactorsDict
4910
4911	@property
4912	def OrthotropicTabularCorrectionFactors(self) -> dict[OrthotropicCorrectionFactorPoint, OrthotropicTabularCorrectionFactor]:
4913		orthotropicTabularCorrectionFactorsDict = {}
4914		for kvp in self._Entity.OrthotropicTabularCorrectionFactors:
4915			orthotropicTabularCorrectionFactorsDict[OrthotropicCorrectionFactorPoint(kvp.Key)] = OrthotropicTabularCorrectionFactor(kvp.Value)
4916
4917		return orthotropicTabularCorrectionFactorsDict
4918
4919	@MaterialFamilyName.setter
4920	def MaterialFamilyName(self, value: str) -> None:
4921		self._Entity.MaterialFamilyName = value
4922
4923	@Name.setter
4924	def Name(self, value: str) -> None:
4925		self._Entity.Name = value
4926
4927	@Form.setter
4928	def Form(self, value: str) -> None:
4929		self._Entity.Form = value
4930
4931	@Specification.setter
4932	def Specification(self, value: str) -> None:
4933		self._Entity.Specification = value
4934
4935	@Basis.setter
4936	def Basis(self, value: str) -> None:
4937		self._Entity.Basis = value
4938
4939	@Wet.setter
4940	def Wet(self, value: bool) -> None:
4941		self._Entity.Wet = value
4942
4943	@Thickness.setter
4944	def Thickness(self, value: float) -> None:
4945		self._Entity.Thickness = value
4946
4947	@Density.setter
4948	def Density(self, value: float) -> None:
4949		self._Entity.Density = value
4950
4951	@FiberVolume.setter
4952	def FiberVolume(self, value: float) -> None:
4953		self._Entity.FiberVolume = value
4954
4955	@GlassTransition.setter
4956	def GlassTransition(self, value: float) -> None:
4957		self._Entity.GlassTransition = value
4958
4959	@Manufacturer.setter
4960	def Manufacturer(self, value: str) -> None:
4961		self._Entity.Manufacturer = value
4962
4963	@Processes.setter
4964	def Processes(self, value: str) -> None:
4965		self._Entity.Processes = value
4966
4967	@MaterialDescription.setter
4968	def MaterialDescription(self, value: str) -> None:
4969		self._Entity.MaterialDescription = value
4970
4971	@UserNote.setter
4972	def UserNote(self, value: str) -> None:
4973		self._Entity.UserNote = value
4974
4975	@BendingCorrectionFactor.setter
4976	def BendingCorrectionFactor(self, value: float) -> None:
4977		self._Entity.BendingCorrectionFactor = value
4978
4979	@FemMaterialId.setter
4980	def FemMaterialId(self, value: int) -> None:
4981		self._Entity.FemMaterialId = value
4982
4983	@Cost.setter
4984	def Cost(self, value: float) -> None:
4985		self._Entity.Cost = value
4986
4987	@BucklingStiffnessKnockdown.setter
4988	def BucklingStiffnessKnockdown(self, value: float) -> None:
4989		self._Entity.BucklingStiffnessKnockdown = value
4990
4991	def AddTemperatureProperty(self, temperature: float, et1: float, et2: float, vt12: float, ec1: float, ec2: float, vc12: float, g12: float, ftu1: float, ftu2: float, fcu1: float, fcu2: float, fsu12: float, alpha1: float, alpha2: float, etu1: float, etu2: float, ecu1: float, ecu2: float, esu12: float) -> OrthotropicTemperature:
4992		return OrthotropicTemperature(self._Entity.AddTemperatureProperty(temperature, et1, et2, vt12, ec1, ec2, vc12, g12, ftu1, ftu2, fcu1, fcu2, fsu12, alpha1, alpha2, etu1, etu2, ecu1, ecu2, esu12))
4993
4994	def DeleteTemperatureProperty(self, temperature: float) -> bool:
4995		return self._Entity.DeleteTemperatureProperty(temperature)
4996
4997	def GetTemperature(self, lookupTemperature: float) -> OrthotropicTemperature:
4998		return OrthotropicTemperature(self._Entity.GetTemperature(lookupTemperature))
4999
5000	def IsEffectiveLaminate(self) -> bool:
5001		'''
5002		Returns true if this material is an effective laminate.
5003		'''
5004		return self._Entity.IsEffectiveLaminate()
5005
5006	def HasLaminateAllowable(self, property: types.AllowablePropertyName) -> bool:
5007		return self._Entity.HasLaminateAllowable(_types.AllowablePropertyName(property.value))
5008
5009	def AddLaminateAllowable(self, property: types.AllowablePropertyName, method: types.AllowableMethodName) -> OrthotropicLaminateAllowable:
5010		return OrthotropicLaminateAllowable(self._Entity.AddLaminateAllowable(_types.AllowablePropertyName(property.value), _types.AllowableMethodName(method.value)))
5011
5012	def GetLaminateAllowable(self, lookupAllowableProperty: types.AllowablePropertyName) -> OrthotropicLaminateAllowable:
5013		return OrthotropicLaminateAllowable(self._Entity.GetLaminateAllowable(_types.AllowablePropertyName(lookupAllowableProperty.value)))
5014
5015	def AddEquationCorrectionFactor(self, propertyId: types.CorrectionProperty, correctionId: types.CorrectionId, equationId: types.CorrectionEquation) -> OrthotropicEquationCorrectionFactor:
5016		return OrthotropicEquationCorrectionFactor(self._Entity.AddEquationCorrectionFactor(_types.CorrectionProperty(propertyId.value), _types.CorrectionId(correctionId.value), _types.CorrectionEquation(equationId.value)))
5017
5018	def GetEquationCorrectionFactor(self, property: types.CorrectionProperty, correction: types.CorrectionId) -> OrthotropicEquationCorrectionFactor:
5019		return OrthotropicEquationCorrectionFactor(self._Entity.GetEquationCorrectionFactor(_types.CorrectionProperty(property.value), _types.CorrectionId(correction.value)))
5020
5021	def GetTabularCorrectionFactor(self, property: types.CorrectionProperty, correction: types.CorrectionId) -> OrthotropicTabularCorrectionFactor:
5022		return OrthotropicTabularCorrectionFactor(self._Entity.GetTabularCorrectionFactor(_types.CorrectionProperty(property.value), _types.CorrectionId(correction.value)))
5023
5024	def Save(self) -> None:
5025		'''
5026		Save any changes to this orthotropic material to the database.
5027		'''
5028		return self._Entity.Save()
5029
5030
5031class Vector2d:
5032	'''
5033	Represents a readonly 2D vector.
5034	'''
5035	def __init__(self, vector2d: _api.Vector2d):
5036		self._Entity = vector2d
5037
5038	def Create_Vector2d(x: float, y: float):
5039		return Vector2d(_api.Vector2d(x, y))
5040
5041	@property
5042	def X(self) -> float:
5043		return self._Entity.X
5044
5045	@property
5046	def Y(self) -> float:
5047		return self._Entity.Y
5048
5049	@overload
5050	def Equals(self, other) -> bool: ...
5051
5052	@overload
5053	def Equals(self, obj) -> bool: ...
5054
5055	def GetHashCode(self) -> int:
5056		return self._Entity.GetHashCode()
5057
5058	def Equals(self, item1 = None) -> bool:
5059		if isinstance(item1, Vector2d):
5060			return self._Entity.Equals(item1._Entity)
5061
5062		return self._Entity.Equals(item1._Entity)
5063
5064	def __eq__(self, other):
5065		return self.Equals(other)
5066
5067	def __ne__(self, other):
5068		return not self.Equals(other)
5069
5070
5071class ElementSet(IdNameEntity):
5072	'''
5073	A set of elements defined in the input file.
5074	'''
5075	def __init__(self, elementSet: _api.ElementSet):
5076		self._Entity = elementSet
5077
5078	@property
5079	def Elements(self) -> ElementCol:
5080		result = self._Entity.Elements
5081		return ElementCol(result) if result is not None else None
5082
5083
5084class FemProperty(IdNameEntity):
5085	'''
5086	A property description.
5087	'''
5088	def __init__(self, femProperty: _api.FemProperty):
5089		self._Entity = femProperty
5090
5091	@property
5092	def Elements(self) -> ElementCol:
5093		result = self._Entity.Elements
5094		return ElementCol(result) if result is not None else None
5095
5096	@property
5097	def FemType(self) -> types.FemType:
5098		return types.FemType[self._Entity.FemType.ToString()]
5099
5100
5101class ElementSetCol(IdEntityCol[ElementSet]):
5102	def __init__(self, elementSetCol: _api.ElementSetCol):
5103		self._Entity = elementSetCol
5104		self._CollectedClass = ElementSet
5105
5106	@property
5107	def ElementSetColList(self) -> tuple[ElementSet]:
5108		return tuple([ElementSet(elementSetCol) for elementSetCol in self._Entity])
5109
5110	def __getitem__(self, index: int):
5111		return self.ElementSetColList[index]
5112
5113	def __iter__(self):
5114		yield from self.ElementSetColList
5115
5116	def __len__(self):
5117		return len(self.ElementSetColList)
5118
5119
5120class FemPropertyCol(IdEntityCol[FemProperty]):
5121	def __init__(self, femPropertyCol: _api.FemPropertyCol):
5122		self._Entity = femPropertyCol
5123		self._CollectedClass = FemProperty
5124
5125	@property
5126	def FemPropertyColList(self) -> tuple[FemProperty]:
5127		return tuple([FemProperty(femPropertyCol) for femPropertyCol in self._Entity])
5128
5129	def __getitem__(self, index: int):
5130		return self.FemPropertyColList[index]
5131
5132	def __iter__(self):
5133		yield from self.FemPropertyColList
5134
5135	def __len__(self):
5136		return len(self.FemPropertyColList)
5137
5138
5139class FemDataSet:
5140	def __init__(self, femDataSet: _api.FemDataSet):
5141		self._Entity = femDataSet
5142
5143	@property
5144	def FemProperties(self) -> FemPropertyCol:
5145		result = self._Entity.FemProperties
5146		return FemPropertyCol(result) if result is not None else None
5147
5148	@property
5149	def ElementSets(self) -> ElementSetCol:
5150		result = self._Entity.ElementSets
5151		return ElementSetCol(result) if result is not None else None
5152
5153
5154class PluginPackage(IdNameEntity):
5155	def __init__(self, pluginPackage: _api.PluginPackage):
5156		self._Entity = pluginPackage
5157
5158	@property
5159	def FilePath(self) -> str:
5160		return self._Entity.FilePath
5161
5162	@property
5163	def Version(self) -> str:
5164		return self._Entity.Version
5165
5166	@property
5167	def Description(self) -> str:
5168		return self._Entity.Description
5169
5170	@property
5171	def ModificationDate(self) -> DateTime:
5172		return self._Entity.ModificationDate
5173
5174
5175class Ply(IdNameEntity):
5176	def __init__(self, ply: _api.Ply):
5177		self._Entity = ply
5178
5179	@property
5180	def InnerCurves(self) -> list[int]:
5181		return [int32 for int32 in self._Entity.InnerCurves]
5182
5183	@property
5184	def OuterCurves(self) -> list[int]:
5185		return [int32 for int32 in self._Entity.OuterCurves]
5186
5187	@property
5188	def FiberDirectionCurves(self) -> list[int]:
5189		return [int32 for int32 in self._Entity.FiberDirectionCurves]
5190
5191	@property
5192	def Area(self) -> float:
5193		return self._Entity.Area
5194
5195	@property
5196	def Description(self) -> str:
5197		return self._Entity.Description
5198
5199	@property
5200	def Elements(self) -> ElementCol:
5201		result = self._Entity.Elements
5202		return ElementCol(result) if result is not None else None
5203
5204	@property
5205	def MaterialId(self) -> int:
5206		return self._Entity.MaterialId
5207
5208	@property
5209	def Orientation(self) -> int:
5210		return self._Entity.Orientation
5211
5212	@property
5213	def Sequence(self) -> int:
5214		return self._Entity.Sequence
5215
5216	@property
5217	def StructureId(self) -> int:
5218		return self._Entity.StructureId
5219
5220	@property
5221	def Thickness(self) -> float:
5222		return self._Entity.Thickness
5223
5224
5225class Rundeck(IdEntity):
5226	def __init__(self, rundeck: _api.Rundeck):
5227		self._Entity = rundeck
5228
5229	@property
5230	def InputFilePath(self) -> str:
5231		return self._Entity.InputFilePath
5232
5233	@property
5234	def IsPrimary(self) -> bool:
5235		return self._Entity.IsPrimary
5236
5237	@property
5238	def ResultFilePath(self) -> str:
5239		return self._Entity.ResultFilePath
5240
5241	def SetInputFilePath(self, filepath: str) -> RundeckUpdateStatus:
5242		return RundeckUpdateStatus[self._Entity.SetInputFilePath(filepath).ToString()]
5243
5244	def SetResultFilePath(self, filepath: str) -> RundeckUpdateStatus:
5245		return RundeckUpdateStatus[self._Entity.SetResultFilePath(filepath).ToString()]
5246
5247
5248class RundeckPathPair:
5249	def __init__(self, rundeckPathPair: _api.RundeckPathPair):
5250		self._Entity = rundeckPathPair
5251
5252	@property
5253	def InputFilePath(self) -> str:
5254		return self._Entity.InputFilePath
5255
5256	@property
5257	def ResultFilePath(self) -> str:
5258		return self._Entity.ResultFilePath
5259
5260	@InputFilePath.setter
5261	def InputFilePath(self, value: str) -> None:
5262		self._Entity.InputFilePath = value
5263
5264	@ResultFilePath.setter
5265	def ResultFilePath(self, value: str) -> None:
5266		self._Entity.ResultFilePath = value
5267
5268
5269class BeamLoads:
5270	def __init__(self, beamLoads: _api.BeamLoads):
5271		self._Entity = beamLoads
5272
5273	@property
5274	def AxialForce(self) -> float:
5275		return self._Entity.AxialForce
5276
5277	@property
5278	def MomentX(self) -> float:
5279		return self._Entity.MomentX
5280
5281	@property
5282	def MomentY(self) -> float:
5283		return self._Entity.MomentY
5284
5285	@property
5286	def ShearX(self) -> float:
5287		return self._Entity.ShearX
5288
5289	@property
5290	def ShearY(self) -> float:
5291		return self._Entity.ShearY
5292
5293	@property
5294	def Torque(self) -> float:
5295		return self._Entity.Torque
5296
5297
5298class SectionCut(IdNameEntity):
5299	def __init__(self, sectionCut: _api.SectionCut):
5300		self._Entity = sectionCut
5301
5302	@property
5303	def ReferencePoint(self) -> types.SectionCutPropertyLocation:
5304		'''
5305		Centroid vs Origin
5306		'''
5307		return types.SectionCutPropertyLocation[self._Entity.ReferencePoint.ToString()]
5308
5309	@property
5310	def HorizontalVector(self) -> Vector3d:
5311		'''
5312		Represents a readonly 3D vector.
5313		'''
5314		result = self._Entity.HorizontalVector
5315		return Vector3d(result) if result is not None else None
5316
5317	@property
5318	def NormalVector(self) -> Vector3d:
5319		'''
5320		Represents a readonly 3D vector.
5321		'''
5322		result = self._Entity.NormalVector
5323		return Vector3d(result) if result is not None else None
5324
5325	@property
5326	def OriginVector(self) -> Vector3d:
5327		'''
5328		Represents a readonly 3D vector.
5329		'''
5330		result = self._Entity.OriginVector
5331		return Vector3d(result) if result is not None else None
5332
5333	@property
5334	def VerticalVector(self) -> Vector3d:
5335		'''
5336		Represents a readonly 3D vector.
5337		'''
5338		result = self._Entity.VerticalVector
5339		return Vector3d(result) if result is not None else None
5340
5341	@property
5342	def MaxAngleBound(self) -> float:
5343		return self._Entity.MaxAngleBound
5344
5345	@property
5346	def MinAngleBound(self) -> float:
5347		return self._Entity.MinAngleBound
5348
5349	@property
5350	def MinStiffnessEihh(self) -> float:
5351		return self._Entity.MinStiffnessEihh
5352
5353	@property
5354	def MinStiffnessEivv(self) -> float:
5355		return self._Entity.MinStiffnessEivv
5356
5357	@property
5358	def MinStiffnessGJ(self) -> float:
5359		return self._Entity.MinStiffnessGJ
5360
5361	@property
5362	def ZoneStiffnessDistribution(self) -> float:
5363		return self._Entity.ZoneStiffnessDistribution
5364
5365	@property
5366	def CN_hmax(self) -> float:
5367		return self._Entity.CN_hmax
5368
5369	@property
5370	def CN_hmin(self) -> float:
5371		return self._Entity.CN_hmin
5372
5373	@property
5374	def CN_vmax(self) -> float:
5375		return self._Entity.CN_vmax
5376
5377	@property
5378	def CN_vmin(self) -> float:
5379		return self._Entity.CN_vmin
5380
5381	@property
5382	def CQ_hmax(self) -> float:
5383		return self._Entity.CQ_hmax
5384
5385	@property
5386	def CQ_hmin(self) -> float:
5387		return self._Entity.CQ_hmin
5388
5389	@property
5390	def CQ_vmax(self) -> float:
5391		return self._Entity.CQ_vmax
5392
5393	@property
5394	def CQ_vmin(self) -> float:
5395		return self._Entity.CQ_vmin
5396
5397	@property
5398	def CG(self) -> Vector2d:
5399		'''
5400		Represents a readonly 2D vector.
5401		'''
5402		result = self._Entity.CG
5403		return Vector2d(result) if result is not None else None
5404
5405	@property
5406	def CN(self) -> Vector2d:
5407		'''
5408		Represents a readonly 2D vector.
5409		'''
5410		result = self._Entity.CN
5411		return Vector2d(result) if result is not None else None
5412
5413	@property
5414	def CQ(self) -> Vector2d:
5415		'''
5416		Represents a readonly 2D vector.
5417		'''
5418		result = self._Entity.CQ
5419		return Vector2d(result) if result is not None else None
5420
5421	@property
5422	def EnclosedArea(self) -> float:
5423		return self._Entity.EnclosedArea
5424
5425	@property
5426	def NumberOfCells(self) -> int:
5427		return self._Entity.NumberOfCells
5428
5429	@property
5430	def EIhh(self) -> float:
5431		return self._Entity.EIhh
5432
5433	@property
5434	def EIhv(self) -> float:
5435		return self._Entity.EIhv
5436
5437	@property
5438	def EIvv(self) -> float:
5439		return self._Entity.EIvv
5440
5441	@property
5442	def GJ(self) -> float:
5443		return self._Entity.GJ
5444
5445	@property
5446	def EA(self) -> float:
5447		return self._Entity.EA
5448
5449	@property
5450	def EImax(self) -> float:
5451		return self._Entity.EImax
5452
5453	@property
5454	def EImin(self) -> float:
5455		return self._Entity.EImin
5456
5457	@property
5458	def PrincipalAngle(self) -> float:
5459		return self._Entity.PrincipalAngle
5460
5461	@property
5462	def Elements(self) -> ElementCol:
5463		result = self._Entity.Elements
5464		return ElementCol(result) if result is not None else None
5465
5466	@property
5467	def PlateElements(self) -> ElementCol:
5468		result = self._Entity.PlateElements
5469		return ElementCol(result) if result is not None else None
5470
5471	@property
5472	def BeamElements(self) -> ElementCol:
5473		result = self._Entity.BeamElements
5474		return ElementCol(result) if result is not None else None
5475
5476	@ReferencePoint.setter
5477	def ReferencePoint(self, value: types.SectionCutPropertyLocation) -> None:
5478		self._Entity.ReferencePoint = _types.SectionCutPropertyLocation(value.value)
5479
5480	@MaxAngleBound.setter
5481	def MaxAngleBound(self, value: float) -> None:
5482		self._Entity.MaxAngleBound = value
5483
5484	@MinAngleBound.setter
5485	def MinAngleBound(self, value: float) -> None:
5486		self._Entity.MinAngleBound = value
5487
5488	@MinStiffnessEihh.setter
5489	def MinStiffnessEihh(self, value: float) -> None:
5490		self._Entity.MinStiffnessEihh = value
5491
5492	@MinStiffnessEivv.setter
5493	def MinStiffnessEivv(self, value: float) -> None:
5494		self._Entity.MinStiffnessEivv = value
5495
5496	@MinStiffnessGJ.setter
5497	def MinStiffnessGJ(self, value: float) -> None:
5498		self._Entity.MinStiffnessGJ = value
5499
5500	@ZoneStiffnessDistribution.setter
5501	def ZoneStiffnessDistribution(self, value: float) -> None:
5502		self._Entity.ZoneStiffnessDistribution = value
5503
5504	@CN_hmax.setter
5505	def CN_hmax(self, value: float) -> None:
5506		self._Entity.CN_hmax = value
5507
5508	@CN_hmin.setter
5509	def CN_hmin(self, value: float) -> None:
5510		self._Entity.CN_hmin = value
5511
5512	@CN_vmax.setter
5513	def CN_vmax(self, value: float) -> None:
5514		self._Entity.CN_vmax = value
5515
5516	@CN_vmin.setter
5517	def CN_vmin(self, value: float) -> None:
5518		self._Entity.CN_vmin = value
5519
5520	@CQ_hmax.setter
5521	def CQ_hmax(self, value: float) -> None:
5522		self._Entity.CQ_hmax = value
5523
5524	@CQ_hmin.setter
5525	def CQ_hmin(self, value: float) -> None:
5526		self._Entity.CQ_hmin = value
5527
5528	@CQ_vmax.setter
5529	def CQ_vmax(self, value: float) -> None:
5530		self._Entity.CQ_vmax = value
5531
5532	@CQ_vmin.setter
5533	def CQ_vmin(self, value: float) -> None:
5534		self._Entity.CQ_vmin = value
5535
5536	def AlignToHorizontalPrincipalAxes(self) -> None:
5537		'''
5538		Set this Section Cut's horizontal vector to be equal to its principal axis horizontal vector.
5539		'''
5540		return self._Entity.AlignToHorizontalPrincipalAxes()
5541
5542	def AlignToVerticalPrincipalAxes(self) -> None:
5543		'''
5544		Set this Section Cut's horizontal vector to be equal to its principal axis vertical vector.
5545		'''
5546		return self._Entity.AlignToVerticalPrincipalAxes()
5547
5548	def SetHorizontalVector(self, vector: Vector3d) -> None:
5549		return self._Entity.SetHorizontalVector(vector._Entity)
5550
5551	def SetNormalVector(self, vector: Vector3d) -> None:
5552		return self._Entity.SetNormalVector(vector._Entity)
5553
5554	def SetOrigin(self, vector: Vector3d) -> None:
5555		return self._Entity.SetOrigin(vector._Entity)
5556
5557	def GetBeamLoads(self, loadCaseId: int, factor: types.LoadSubCaseFactor) -> BeamLoads:
5558		return BeamLoads(self._Entity.GetBeamLoads(loadCaseId, _types.LoadSubCaseFactor(factor.value)))
5559
5560	def InclinationAngle(self, loadCaseId: int, factor: types.LoadSubCaseFactor) -> float:
5561		return self._Entity.InclinationAngle(loadCaseId, _types.LoadSubCaseFactor(factor.value))
5562
5563	def HorizontalIntercept(self, loadCaseId: int, factor: types.LoadSubCaseFactor) -> float:
5564		return self._Entity.HorizontalIntercept(loadCaseId, _types.LoadSubCaseFactor(factor.value))
5565
5566	def VerticalIntercept(self, loadCaseId: int, factor: types.LoadSubCaseFactor) -> float:
5567		return self._Entity.VerticalIntercept(loadCaseId, _types.LoadSubCaseFactor(factor.value))
5568
5569	def SetElements(self, elements: list[int]) -> bool:
5570		elementsList = MakeCSharpIntList(elements)
5571		return self._Entity.SetElements(elementsList)
5572
5573	def SetElementsByIntersection(self) -> None:
5574		return self._Entity.SetElementsByIntersection()
5575
5576
5577class Set(ZoneJointContainer):
5578	def __init__(self, set: _api.Set):
5579		self._Entity = set
5580
5581	@property
5582	def Joints(self) -> JointCol:
5583		result = self._Entity.Joints
5584		return JointCol(result) if result is not None else None
5585
5586	@property
5587	def PanelSegments(self) -> PanelSegmentCol:
5588		result = self._Entity.PanelSegments
5589		return PanelSegmentCol(result) if result is not None else None
5590
5591	@property
5592	def Zones(self) -> ZoneCol:
5593		result = self._Entity.Zones
5594		return ZoneCol(result) if result is not None else None
5595
5596	@overload
5597	def AddJoint(self, joint: Joint) -> CollectionModificationStatus: ...
5598
5599	@overload
5600	def AddPanelSegment(self, segment: PanelSegment) -> CollectionModificationStatus: ...
5601
5602	@overload
5603	def AddZones(self, zones: tuple[Zone]) -> CollectionModificationStatus: ...
5604
5605	@overload
5606	def RemoveJoints(self, jointIds: tuple[int]) -> CollectionModificationStatus: ...
5607
5608	@overload
5609	def RemovePanelSegments(self, segmentIds: tuple[int]) -> CollectionModificationStatus: ...
5610
5611	@overload
5612	def RemoveZones(self, zoneIds: tuple[int]) -> CollectionModificationStatus: ...
5613
5614	@overload
5615	def AddJoint(self, id: int) -> CollectionModificationStatus: ...
5616
5617	@overload
5618	def RemoveJoint(self, id: int) -> CollectionModificationStatus: ...
5619
5620	@overload
5621	def RemoveJoint(self, joint: Joint) -> CollectionModificationStatus: ...
5622
5623	@overload
5624	def RemoveJoints(self, joints: JointCol) -> CollectionModificationStatus: ...
5625
5626	@overload
5627	def AddZone(self, id: int) -> CollectionModificationStatus: ...
5628
5629	@overload
5630	def AddZones(self, ids: tuple[int]) -> CollectionModificationStatus: ...
5631
5632	@overload
5633	def AddZone(self, zone: Zone) -> CollectionModificationStatus: ...
5634
5635	@overload
5636	def RemoveZone(self, id: int) -> CollectionModificationStatus: ...
5637
5638	@overload
5639	def RemoveZone(self, zone: Zone) -> CollectionModificationStatus: ...
5640
5641	@overload
5642	def RemoveZones(self, zones: ZoneCol) -> CollectionModificationStatus: ...
5643
5644	@overload
5645	def AddPanelSegment(self, id: int) -> CollectionModificationStatus: ...
5646
5647	@overload
5648	def RemovePanelSegment(self, id: int) -> CollectionModificationStatus: ...
5649
5650	@overload
5651	def RemovePanelSegment(self, segment: PanelSegment) -> CollectionModificationStatus: ...
5652
5653	@overload
5654	def RemovePanelSegments(self, segments: PanelSegmentCol) -> CollectionModificationStatus: ...
5655
5656	def AddJoint(self, item1 = None) -> CollectionModificationStatus:
5657		if isinstance(item1, Joint):
5658			return CollectionModificationStatus[self._Entity.AddJoint(item1._Entity).ToString()]
5659
5660		if isinstance(item1, int):
5661			return CollectionModificationStatus(super().AddJoint(item1))
5662
5663		return CollectionModificationStatus[self._Entity.AddJoint(item1._Entity).ToString()]
5664
5665	def AddPanelSegment(self, item1 = None) -> CollectionModificationStatus:
5666		if isinstance(item1, PanelSegment):
5667			return CollectionModificationStatus[self._Entity.AddPanelSegment(item1._Entity).ToString()]
5668
5669		if isinstance(item1, int):
5670			return CollectionModificationStatus(super().AddPanelSegment(item1))
5671
5672		return CollectionModificationStatus[self._Entity.AddPanelSegment(item1._Entity).ToString()]
5673
5674	def AddZones(self, item1 = None) -> CollectionModificationStatus:
5675		if isinstance(item1, tuple) and item1 and isinstance(item1[0], Zone):
5676			zonesList = List[_api.Zone]()
5677			if item1 is not None:
5678				for thing in item1:
5679					if thing is not None:
5680						zonesList.Add(thing._Entity)
5681			zonesEnumerable = IEnumerable(zonesList)
5682			return CollectionModificationStatus[self._Entity.AddZones(zonesEnumerable).ToString()]
5683
5684		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
5685			return CollectionModificationStatus(super().AddZones(item1))
5686
5687		return CollectionModificationStatus[self._Entity.AddZones(item1).ToString()]
5688
5689	def RemoveJoints(self, item1 = None) -> CollectionModificationStatus:
5690		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
5691			jointIdsList = MakeCSharpIntList(item1)
5692			jointIdsEnumerable = IEnumerable(jointIdsList)
5693			return CollectionModificationStatus[self._Entity.RemoveJoints(jointIdsEnumerable).ToString()]
5694
5695		if isinstance(item1, JointCol):
5696			return CollectionModificationStatus(super().RemoveJoints(item1))
5697
5698		return CollectionModificationStatus[self._Entity.RemoveJoints(item1).ToString()]
5699
5700	def RemovePanelSegments(self, item1 = None) -> CollectionModificationStatus:
5701		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
5702			segmentIdsList = MakeCSharpIntList(item1)
5703			segmentIdsEnumerable = IEnumerable(segmentIdsList)
5704			return CollectionModificationStatus[self._Entity.RemovePanelSegments(segmentIdsEnumerable).ToString()]
5705
5706		if isinstance(item1, PanelSegmentCol):
5707			return CollectionModificationStatus(super().RemovePanelSegments(item1))
5708
5709		return CollectionModificationStatus[self._Entity.RemovePanelSegments(item1).ToString()]
5710
5711	def RemoveZones(self, item1 = None) -> CollectionModificationStatus:
5712		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
5713			zoneIdsList = MakeCSharpIntList(item1)
5714			zoneIdsEnumerable = IEnumerable(zoneIdsList)
5715			return CollectionModificationStatus[self._Entity.RemoveZones(zoneIdsEnumerable).ToString()]
5716
5717		if isinstance(item1, ZoneCol):
5718			return CollectionModificationStatus(super().RemoveZones(item1))
5719
5720		return CollectionModificationStatus[self._Entity.RemoveZones(item1).ToString()]
5721
5722	def RemoveJoint(self, item1 = None) -> CollectionModificationStatus:
5723		if isinstance(item1, int):
5724			return CollectionModificationStatus(super().RemoveJoint(item1))
5725
5726		if isinstance(item1, Joint):
5727			return CollectionModificationStatus(super().RemoveJoint(item1))
5728
5729		return CollectionModificationStatus[self._Entity.RemoveJoint(item1).ToString()]
5730
5731	def AddZone(self, item1 = None) -> CollectionModificationStatus:
5732		if isinstance(item1, int):
5733			return CollectionModificationStatus(super().AddZone(item1))
5734
5735		if isinstance(item1, Zone):
5736			return CollectionModificationStatus(super().AddZone(item1))
5737
5738		return CollectionModificationStatus[self._Entity.AddZone(item1).ToString()]
5739
5740	def RemoveZone(self, item1 = None) -> CollectionModificationStatus:
5741		if isinstance(item1, int):
5742			return CollectionModificationStatus(super().RemoveZone(item1))
5743
5744		if isinstance(item1, Zone):
5745			return CollectionModificationStatus(super().RemoveZone(item1))
5746
5747		return CollectionModificationStatus[self._Entity.RemoveZone(item1).ToString()]
5748
5749	def RemovePanelSegment(self, item1 = None) -> CollectionModificationStatus:
5750		if isinstance(item1, int):
5751			return CollectionModificationStatus(super().RemovePanelSegment(item1))
5752
5753		if isinstance(item1, PanelSegment):
5754			return CollectionModificationStatus(super().RemovePanelSegment(item1))
5755
5756		return CollectionModificationStatus[self._Entity.RemovePanelSegment(item1).ToString()]
5757
5758
5759class PlyCol(IdNameEntityCol[Ply]):
5760	def __init__(self, plyCol: _api.PlyCol):
5761		self._Entity = plyCol
5762		self._CollectedClass = Ply
5763
5764	@property
5765	def PlyColList(self) -> tuple[Ply]:
5766		return tuple([Ply(plyCol) for plyCol in self._Entity])
5767
5768	def Delete(self, id: int) -> CollectionModificationStatus:
5769		return CollectionModificationStatus[self._Entity.Delete(id).ToString()]
5770
5771	def DeleteAll(self) -> None:
5772		'''
5773		Delete all plies in the collection.
5774		'''
5775		return self._Entity.DeleteAll()
5776
5777	def ExportToCSV(self, filepath: str) -> None:
5778		return self._Entity.ExportToCSV(filepath)
5779
5780	def ImportCSV(self, filepath: str) -> None:
5781		return self._Entity.ImportCSV(filepath)
5782
5783	@overload
5784	def Get(self, name: str) -> Ply: ...
5785
5786	@overload
5787	def Get(self, id: int) -> Ply: ...
5788
5789	def Get(self, item1 = None) -> Ply:
5790		if isinstance(item1, str):
5791			return Ply(super().Get(item1))
5792
5793		if isinstance(item1, int):
5794			return Ply(super().Get(item1))
5795
5796		return Ply(self._Entity.Get(item1))
5797
5798	def __getitem__(self, index: int):
5799		return self.PlyColList[index]
5800
5801	def __iter__(self):
5802		yield from self.PlyColList
5803
5804	def __len__(self):
5805		return len(self.PlyColList)
5806
5807
5808class Structure(ZoneJointContainer):
5809	def __init__(self, structure: _api.Structure):
5810		self._Entity = structure
5811
5812	@property
5813	def Plies(self) -> PlyCol:
5814		result = self._Entity.Plies
5815		return PlyCol(result) if result is not None else None
5816
5817	@property
5818	def Joints(self) -> JointCol:
5819		result = self._Entity.Joints
5820		return JointCol(result) if result is not None else None
5821
5822	@property
5823	def PanelSegments(self) -> PanelSegmentCol:
5824		result = self._Entity.PanelSegments
5825		return PanelSegmentCol(result) if result is not None else None
5826
5827	@property
5828	def Zones(self) -> ZoneCol:
5829		result = self._Entity.Zones
5830		return ZoneCol(result) if result is not None else None
5831
5832	def ExportVCP(self, fileName: str) -> None:
5833		return self._Entity.ExportVCP(fileName)
5834
5835	def AddElements(self, elementIds: tuple[int]) -> CollectionModificationStatus:
5836		elementIdsList = MakeCSharpIntList(elementIds)
5837		elementIdsEnumerable = IEnumerable(elementIdsList)
5838		return CollectionModificationStatus[self._Entity.AddElements(elementIdsEnumerable).ToString()]
5839
5840	@overload
5841	def AddJoint(self, joint: Joint) -> CollectionModificationStatus: ...
5842
5843	@overload
5844	def AddPanelSegment(self, segment: PanelSegment) -> CollectionModificationStatus: ...
5845
5846	def AddPfemProperties(self, pfemPropertyIds: tuple[int]) -> CollectionModificationStatus:
5847		pfemPropertyIdsList = MakeCSharpIntList(pfemPropertyIds)
5848		pfemPropertyIdsEnumerable = IEnumerable(pfemPropertyIdsList)
5849		return CollectionModificationStatus[self._Entity.AddPfemProperties(pfemPropertyIdsEnumerable).ToString()]
5850
5851	@overload
5852	def AddZones(self, zones: tuple[Zone]) -> CollectionModificationStatus: ...
5853
5854	def CreateZone(self, elementIds: tuple[int], name: str = None) -> Zone:
5855		elementIdsList = MakeCSharpIntList(elementIds)
5856		elementIdsEnumerable = IEnumerable(elementIdsList)
5857		result = self._Entity.CreateZone(elementIdsEnumerable, name)
5858		thisClass = type(result).__name__
5859		givenClass = Zone
5860		for subclass in Zone.__subclasses__():
5861			if subclass.__name__ == thisClass:
5862				givenClass = subclass
5863		return givenClass(result)
5864
5865	def CreatePanelSegment(self, discreteTechnique: types.DiscreteTechnique, discreteElementLkp: dict[types.DiscreteDefinitionType, list[int]], name: str = None) -> PanelSegment:
5866		discreteElementLkpDict = Dictionary[_types.DiscreteDefinitionType, List[int]]()
5867		for kvp in discreteElementLkp:
5868			discreteElementLkpDict.Add(_types.DiscreteDefinitionType(kvp.value), MakeCSharpIntList(discreteElementLkp[kvp]))
5869		return PanelSegment(self._Entity.CreatePanelSegment(_types.DiscreteTechnique(discreteTechnique.value), discreteElementLkpDict, name))
5870
5871	@overload
5872	def Remove(self, zoneIds: tuple[int], jointIds: tuple[int]) -> CollectionModificationStatus: ...
5873
5874	@overload
5875	def Remove(self, zoneIds: tuple[int], jointIds: tuple[int], panelSegmentIds: tuple[int]) -> CollectionModificationStatus: ...
5876
5877	@overload
5878	def RemoveJoints(self, jointIds: tuple[int]) -> CollectionModificationStatus: ...
5879
5880	@overload
5881	def RemovePanelSegments(self, segmentIds: tuple[int]) -> CollectionModificationStatus: ...
5882
5883	@overload
5884	def RemoveZones(self, zoneIds: tuple[int]) -> CollectionModificationStatus: ...
5885
5886	@overload
5887	def AddJoint(self, id: int) -> CollectionModificationStatus: ...
5888
5889	@overload
5890	def RemoveJoint(self, id: int) -> CollectionModificationStatus: ...
5891
5892	@overload
5893	def RemoveJoint(self, joint: Joint) -> CollectionModificationStatus: ...
5894
5895	@overload
5896	def RemoveJoints(self, joints: JointCol) -> CollectionModificationStatus: ...
5897
5898	@overload
5899	def AddZone(self, id: int) -> CollectionModificationStatus: ...
5900
5901	@overload
5902	def AddZones(self, ids: tuple[int]) -> CollectionModificationStatus: ...
5903
5904	@overload
5905	def AddZone(self, zone: Zone) -> CollectionModificationStatus: ...
5906
5907	@overload
5908	def RemoveZone(self, id: int) -> CollectionModificationStatus: ...
5909
5910	@overload
5911	def RemoveZone(self, zone: Zone) -> CollectionModificationStatus: ...
5912
5913	@overload
5914	def RemoveZones(self, zones: ZoneCol) -> CollectionModificationStatus: ...
5915
5916	@overload
5917	def AddPanelSegment(self, id: int) -> CollectionModificationStatus: ...
5918
5919	@overload
5920	def RemovePanelSegment(self, id: int) -> CollectionModificationStatus: ...
5921
5922	@overload
5923	def RemovePanelSegment(self, segment: PanelSegment) -> CollectionModificationStatus: ...
5924
5925	@overload
5926	def RemovePanelSegments(self, segments: PanelSegmentCol) -> CollectionModificationStatus: ...
5927
5928	def AddJoint(self, item1 = None) -> CollectionModificationStatus:
5929		if isinstance(item1, Joint):
5930			return CollectionModificationStatus[self._Entity.AddJoint(item1._Entity).ToString()]
5931
5932		if isinstance(item1, int):
5933			return CollectionModificationStatus(super().AddJoint(item1))
5934
5935		return CollectionModificationStatus[self._Entity.AddJoint(item1._Entity).ToString()]
5936
5937	def AddPanelSegment(self, item1 = None) -> CollectionModificationStatus:
5938		if isinstance(item1, PanelSegment):
5939			return CollectionModificationStatus[self._Entity.AddPanelSegment(item1._Entity).ToString()]
5940
5941		if isinstance(item1, int):
5942			return CollectionModificationStatus(super().AddPanelSegment(item1))
5943
5944		return CollectionModificationStatus[self._Entity.AddPanelSegment(item1._Entity).ToString()]
5945
5946	def AddZones(self, item1 = None) -> CollectionModificationStatus:
5947		if isinstance(item1, tuple) and item1 and isinstance(item1[0], Zone):
5948			zonesList = List[_api.Zone]()
5949			if item1 is not None:
5950				for thing in item1:
5951					if thing is not None:
5952						zonesList.Add(thing._Entity)
5953			zonesEnumerable = IEnumerable(zonesList)
5954			return CollectionModificationStatus[self._Entity.AddZones(zonesEnumerable).ToString()]
5955
5956		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
5957			return CollectionModificationStatus(super().AddZones(item1))
5958
5959		return CollectionModificationStatus[self._Entity.AddZones(item1).ToString()]
5960
5961	def Remove(self, item1 = None, item2 = None, item3 = None) -> CollectionModificationStatus:
5962		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int) and isinstance(item2, tuple) and item2 and isinstance(item2[0], int) and isinstance(item3, tuple) and item3 and isinstance(item3[0], int):
5963			zoneIdsList = MakeCSharpIntList(item1)
5964			zoneIdsEnumerable = IEnumerable(zoneIdsList)
5965			jointIdsList = MakeCSharpIntList(item2)
5966			jointIdsEnumerable = IEnumerable(jointIdsList)
5967			panelSegmentIdsList = MakeCSharpIntList(item3)
5968			panelSegmentIdsEnumerable = IEnumerable(panelSegmentIdsList)
5969			return CollectionModificationStatus[self._Entity.Remove(zoneIdsEnumerable, jointIdsEnumerable, panelSegmentIdsEnumerable).ToString()]
5970
5971		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int) and isinstance(item2, tuple) and item2 and isinstance(item2[0], int):
5972			zoneIdsList = MakeCSharpIntList(item1)
5973			zoneIdsEnumerable = IEnumerable(zoneIdsList)
5974			jointIdsList = MakeCSharpIntList(item2)
5975			jointIdsEnumerable = IEnumerable(jointIdsList)
5976			return CollectionModificationStatus[self._Entity.Remove(zoneIdsEnumerable, jointIdsEnumerable).ToString()]
5977
5978		return CollectionModificationStatus[self._Entity.Remove(item1, item2, item3).ToString()]
5979
5980	def RemoveJoints(self, item1 = None) -> CollectionModificationStatus:
5981		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
5982			jointIdsList = MakeCSharpIntList(item1)
5983			jointIdsEnumerable = IEnumerable(jointIdsList)
5984			return CollectionModificationStatus[self._Entity.RemoveJoints(jointIdsEnumerable).ToString()]
5985
5986		if isinstance(item1, JointCol):
5987			return CollectionModificationStatus(super().RemoveJoints(item1))
5988
5989		return CollectionModificationStatus[self._Entity.RemoveJoints(item1).ToString()]
5990
5991	def RemovePanelSegments(self, item1 = None) -> CollectionModificationStatus:
5992		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
5993			segmentIdsList = MakeCSharpIntList(item1)
5994			segmentIdsEnumerable = IEnumerable(segmentIdsList)
5995			return CollectionModificationStatus[self._Entity.RemovePanelSegments(segmentIdsEnumerable).ToString()]
5996
5997		if isinstance(item1, PanelSegmentCol):
5998			return CollectionModificationStatus(super().RemovePanelSegments(item1))
5999
6000		return CollectionModificationStatus[self._Entity.RemovePanelSegments(item1).ToString()]
6001
6002	def RemoveZones(self, item1 = None) -> CollectionModificationStatus:
6003		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
6004			zoneIdsList = MakeCSharpIntList(item1)
6005			zoneIdsEnumerable = IEnumerable(zoneIdsList)
6006			return CollectionModificationStatus[self._Entity.RemoveZones(zoneIdsEnumerable).ToString()]
6007
6008		if isinstance(item1, ZoneCol):
6009			return CollectionModificationStatus(super().RemoveZones(item1))
6010
6011		return CollectionModificationStatus[self._Entity.RemoveZones(item1).ToString()]
6012
6013	def RemoveJoint(self, item1 = None) -> CollectionModificationStatus:
6014		if isinstance(item1, int):
6015			return CollectionModificationStatus(super().RemoveJoint(item1))
6016
6017		if isinstance(item1, Joint):
6018			return CollectionModificationStatus(super().RemoveJoint(item1))
6019
6020		return CollectionModificationStatus[self._Entity.RemoveJoint(item1).ToString()]
6021
6022	def AddZone(self, item1 = None) -> CollectionModificationStatus:
6023		if isinstance(item1, int):
6024			return CollectionModificationStatus(super().AddZone(item1))
6025
6026		if isinstance(item1, Zone):
6027			return CollectionModificationStatus(super().AddZone(item1))
6028
6029		return CollectionModificationStatus[self._Entity.AddZone(item1).ToString()]
6030
6031	def RemoveZone(self, item1 = None) -> CollectionModificationStatus:
6032		if isinstance(item1, int):
6033			return CollectionModificationStatus(super().RemoveZone(item1))
6034
6035		if isinstance(item1, Zone):
6036			return CollectionModificationStatus(super().RemoveZone(item1))
6037
6038		return CollectionModificationStatus[self._Entity.RemoveZone(item1).ToString()]
6039
6040	def RemovePanelSegment(self, item1 = None) -> CollectionModificationStatus:
6041		if isinstance(item1, int):
6042			return CollectionModificationStatus(super().RemovePanelSegment(item1))
6043
6044		if isinstance(item1, PanelSegment):
6045			return CollectionModificationStatus(super().RemovePanelSegment(item1))
6046
6047		return CollectionModificationStatus[self._Entity.RemovePanelSegment(item1).ToString()]
6048
6049
6050class AnalysisPropertyCol(IdNameEntityCol[AnalysisProperty]):
6051	def __init__(self, analysisPropertyCol: _api.AnalysisPropertyCol):
6052		self._Entity = analysisPropertyCol
6053		self._CollectedClass = AnalysisProperty
6054
6055	@property
6056	def AnalysisPropertyColList(self) -> tuple[AnalysisProperty]:
6057		return tuple([AnalysisProperty(analysisPropertyCol) for analysisPropertyCol in self._Entity])
6058
6059	def CreateAnalysisProperty(self, type: types.FamilyCategory, name: str = None) -> AnalysisProperty:
6060		return AnalysisProperty(self._Entity.CreateAnalysisProperty(_types.FamilyCategory(type.value), name))
6061
6062	@overload
6063	def DeleteAnalysisProperty(self, name: str) -> bool: ...
6064
6065	@overload
6066	def DeleteAnalysisProperty(self, id: int) -> bool: ...
6067
6068	@overload
6069	def Get(self, name: str) -> AnalysisProperty: ...
6070
6071	@overload
6072	def Get(self, id: int) -> AnalysisProperty: ...
6073
6074	def DeleteAnalysisProperty(self, item1 = None) -> bool:
6075		if isinstance(item1, str):
6076			return self._Entity.DeleteAnalysisProperty(item1)
6077
6078		if isinstance(item1, int):
6079			return self._Entity.DeleteAnalysisProperty(item1)
6080
6081		return self._Entity.DeleteAnalysisProperty(item1)
6082
6083	def Get(self, item1 = None) -> AnalysisProperty:
6084		if isinstance(item1, str):
6085			return AnalysisProperty(super().Get(item1))
6086
6087		if isinstance(item1, int):
6088			return AnalysisProperty(super().Get(item1))
6089
6090		return AnalysisProperty(self._Entity.Get(item1))
6091
6092	def __getitem__(self, index: int):
6093		return self.AnalysisPropertyColList[index]
6094
6095	def __iter__(self):
6096		yield from self.AnalysisPropertyColList
6097
6098	def __len__(self):
6099		return len(self.AnalysisPropertyColList)
6100
6101
6102class DesignPropertyCol(IdNameEntityCol[DesignProperty]):
6103	def __init__(self, designPropertyCol: _api.DesignPropertyCol):
6104		self._Entity = designPropertyCol
6105		self._CollectedClass = DesignProperty
6106
6107	@property
6108	def DesignPropertyColList(self) -> tuple[DesignProperty]:
6109		return tuple([DesignProperty(designPropertyCol) for designPropertyCol in self._Entity])
6110
6111	def CreateDesignProperty(self, familyConcept: types.FamilyConceptUID, materialMode: types.MaterialMode = types.MaterialMode.Any, name: str = None) -> DesignProperty:
6112		result = self._Entity.CreateDesignProperty(_types.FamilyConceptUID(familyConcept.value), _types.MaterialMode(materialMode.value), name)
6113		thisClass = type(result).__name__
6114		givenClass = DesignProperty
6115		for subclass in DesignProperty.__subclasses__():
6116			if subclass.__name__ == thisClass:
6117				givenClass = subclass
6118		return givenClass(result)
6119
6120	@overload
6121	def Get(self, name: str) -> DesignProperty: ...
6122
6123	@overload
6124	def Get(self, id: int) -> DesignProperty: ...
6125
6126	def Get(self, item1 = None) -> DesignProperty:
6127		if isinstance(item1, str):
6128			return DesignProperty(super().Get(item1))
6129
6130		if isinstance(item1, int):
6131			return DesignProperty(super().Get(item1))
6132
6133		result = self._Entity.Get(item1)
6134		thisClass = type(result).__name__
6135		givenClass = DesignProperty
6136		for subclass in DesignProperty.__subclasses__():
6137			if subclass.__name__ == thisClass:
6138				givenClass = subclass
6139		return givenClass(result)
6140
6141	def __getitem__(self, index: int):
6142		return self.DesignPropertyColList[index]
6143
6144	def __iter__(self):
6145		yield from self.DesignPropertyColList
6146
6147	def __len__(self):
6148		return len(self.DesignPropertyColList)
6149
6150
6151class LoadPropertyCol(IdNameEntityCol[LoadProperty]):
6152	def __init__(self, loadPropertyCol: _api.LoadPropertyCol):
6153		self._Entity = loadPropertyCol
6154		self._CollectedClass = LoadProperty
6155
6156	@property
6157	def LoadPropertyColList(self) -> tuple[LoadProperty]:
6158		return tuple([LoadProperty(loadPropertyCol) for loadPropertyCol in self._Entity])
6159
6160	def CreateLoadProperty(self, loadPropertyType: types.LoadPropertyType, category: types.FamilyCategory, name: str = None) -> LoadProperty:
6161		result = self._Entity.CreateLoadProperty(_types.LoadPropertyType(loadPropertyType.value), _types.FamilyCategory(category.value), name)
6162		thisClass = type(result).__name__
6163		givenClass = LoadProperty
6164		for subclass in LoadProperty.__subclasses__():
6165			if subclass.__name__ == thisClass:
6166				givenClass = subclass
6167		return givenClass(result)
6168
6169	@overload
6170	def DeleteLoadProperty(self, id: int) -> bool: ...
6171
6172	@overload
6173	def DeleteLoadProperty(self, name: str) -> bool: ...
6174
6175	@overload
6176	def Get(self, name: str) -> LoadProperty: ...
6177
6178	@overload
6179	def Get(self, id: int) -> LoadProperty: ...
6180
6181	def DeleteLoadProperty(self, item1 = None) -> bool:
6182		if isinstance(item1, int):
6183			return self._Entity.DeleteLoadProperty(item1)
6184
6185		if isinstance(item1, str):
6186			return self._Entity.DeleteLoadProperty(item1)
6187
6188		return self._Entity.DeleteLoadProperty(item1)
6189
6190	def Get(self, item1 = None) -> LoadProperty:
6191		if isinstance(item1, str):
6192			return LoadProperty(super().Get(item1))
6193
6194		if isinstance(item1, int):
6195			return LoadProperty(super().Get(item1))
6196
6197		result = self._Entity.Get(item1)
6198		thisClass = type(result).__name__
6199		givenClass = LoadProperty
6200		for subclass in LoadProperty.__subclasses__():
6201			if subclass.__name__ == thisClass:
6202				givenClass = subclass
6203		return givenClass(result)
6204
6205	def __getitem__(self, index: int):
6206		return self.LoadPropertyColList[index]
6207
6208	def __iter__(self):
6209		yield from self.LoadPropertyColList
6210
6211	def __len__(self):
6212		return len(self.LoadPropertyColList)
6213
6214
6215class DesignLoadCol(IdNameEntityCol[DesignLoad]):
6216	def __init__(self, designLoadCol: _api.DesignLoadCol):
6217		self._Entity = designLoadCol
6218		self._CollectedClass = DesignLoad
6219
6220	@property
6221	def DesignLoadColList(self) -> tuple[DesignLoad]:
6222		return tuple([DesignLoad(designLoadCol) for designLoadCol in self._Entity])
6223
6224	@overload
6225	def Get(self, name: str) -> DesignLoad: ...
6226
6227	@overload
6228	def Get(self, id: int) -> DesignLoad: ...
6229
6230	def Get(self, item1 = None) -> DesignLoad:
6231		if isinstance(item1, str):
6232			return DesignLoad(super().Get(item1))
6233
6234		if isinstance(item1, int):
6235			return DesignLoad(super().Get(item1))
6236
6237		return DesignLoad(self._Entity.Get(item1))
6238
6239	def __getitem__(self, index: int):
6240		return self.DesignLoadColList[index]
6241
6242	def __iter__(self):
6243		yield from self.DesignLoadColList
6244
6245	def __len__(self):
6246		return len(self.DesignLoadColList)
6247
6248
6249class DiscreteFieldCol(IdNameEntityCol[DiscreteField]):
6250	def __init__(self, discreteFieldCol: _api.DiscreteFieldCol):
6251		self._Entity = discreteFieldCol
6252		self._CollectedClass = DiscreteField
6253
6254	@property
6255	def DiscreteFieldColList(self) -> tuple[DiscreteField]:
6256		return tuple([DiscreteField(discreteFieldCol) for discreteFieldCol in self._Entity])
6257
6258	def Create(self, entityType: types.DiscreteFieldPhysicalEntityType, dataType: types.DiscreteFieldDataType, name: str = None) -> DiscreteField:
6259		return DiscreteField(self._Entity.Create(_types.DiscreteFieldPhysicalEntityType(entityType.value), _types.DiscreteFieldDataType(dataType.value), name))
6260
6261	def CreateFromVCP(self, filepath: str) -> list[DiscreteField]:
6262		return [DiscreteField(discreteField) for discreteField in self._Entity.CreateFromVCP(filepath)]
6263
6264	def Delete(self, id: int) -> CollectionModificationStatus:
6265		return CollectionModificationStatus[self._Entity.Delete(id).ToString()]
6266
6267	def CreateByPointMapToElements(self, elementIds: list[int], discreteFieldIds: list[int], suffix: str = None, tolerance: float = None) -> list[DiscreteField]:
6268		elementIdsList = MakeCSharpIntList(elementIds)
6269		discreteFieldIdsList = MakeCSharpIntList(discreteFieldIds)
6270		return [DiscreteField(discreteField) for discreteField in self._Entity.CreateByPointMapToElements(elementIdsList, discreteFieldIdsList, suffix, tolerance)]
6271
6272	@overload
6273	def Get(self, name: str) -> DiscreteField: ...
6274
6275	@overload
6276	def Get(self, id: int) -> DiscreteField: ...
6277
6278	def Get(self, item1 = None) -> DiscreteField:
6279		if isinstance(item1, str):
6280			return DiscreteField(super().Get(item1))
6281
6282		if isinstance(item1, int):
6283			return DiscreteField(super().Get(item1))
6284
6285		return DiscreteField(self._Entity.Get(item1))
6286
6287	def __getitem__(self, index: int):
6288		return self.DiscreteFieldColList[index]
6289
6290	def __iter__(self):
6291		yield from self.DiscreteFieldColList
6292
6293	def __len__(self):
6294		return len(self.DiscreteFieldColList)
6295
6296
6297class ZoneJointContainerCol(IdNameEntityCol, Generic[T]):
6298	def __init__(self, zoneJointContainerCol: _api.ZoneJointContainerCol):
6299		self._Entity = zoneJointContainerCol
6300		self._CollectedClass = T
6301
6302	@property
6303	def ZoneJointContainerColList(self) -> tuple[T]:
6304		if self._Entity.Count() <= 0:
6305			return ()
6306		thisClass = type(self._Entity._items[0]).__name__
6307		givenClass = T
6308		for subclass in T.__subclasses__():
6309			if subclass.__name__ == thisClass:
6310				givenClass = subclass
6311		return tuple([givenClass(zoneJointContainerCol) for zoneJointContainerCol in self._Entity])
6312
6313	@abstractmethod
6314	def Create(self, name: str) -> T:
6315		return self._Entity.Create(name)
6316
6317	@overload
6318	def Get(self, name: str) -> T: ...
6319
6320	@overload
6321	def Get(self, id: int) -> T: ...
6322
6323	def Get(self, item1 = None) -> T:
6324		if isinstance(item1, str):
6325			return super().Get(item1)
6326
6327		if isinstance(item1, int):
6328			return super().Get(item1)
6329
6330		return self._Entity.Get(item1)
6331
6332	def __getitem__(self, index: int):
6333		return self.ZoneJointContainerColList[index]
6334
6335	def __iter__(self):
6336		yield from self.ZoneJointContainerColList
6337
6338	def __len__(self):
6339		return len(self.ZoneJointContainerColList)
6340
6341
6342class RundeckCol(IdEntityCol[Rundeck]):
6343	def __init__(self, rundeckCol: _api.RundeckCol):
6344		self._Entity = rundeckCol
6345		self._CollectedClass = Rundeck
6346
6347	@property
6348	def RundeckColList(self) -> tuple[Rundeck]:
6349		return tuple([Rundeck(rundeckCol) for rundeckCol in self._Entity])
6350
6351	def AddRundeck(self, inputPath: str, resultPath: str = None) -> Rundeck:
6352		return Rundeck(self._Entity.AddRundeck(inputPath, resultPath))
6353
6354	def ReassignPrimary(self, id: int) -> RundeckUpdateStatus:
6355		return RundeckUpdateStatus[self._Entity.ReassignPrimary(id).ToString()]
6356
6357	def RemoveRundeck(self, id: int) -> RundeckRemoveStatus:
6358		return RundeckRemoveStatus[self._Entity.RemoveRundeck(id).ToString()]
6359
6360	def UpdateAllRundecks(self, newPaths: list[RundeckPathPair]) -> RundeckBulkUpdateStatus:
6361		newPathsList = List[_api.RundeckPathPair]()
6362		if newPaths is not None:
6363			for thing in newPaths:
6364				if thing is not None:
6365					newPathsList.Add(thing._Entity)
6366		return RundeckBulkUpdateStatus[self._Entity.UpdateAllRundecks(newPathsList).ToString()]
6367
6368	def GetRundeckPathSetters(self) -> list[RundeckPathPair]:
6369		'''
6370		Get RundeckPathSetters to be edited and input to UpdateAllRundecks.
6371		'''
6372		return [RundeckPathPair(rundeckPathPair) for rundeckPathPair in self._Entity.GetRundeckPathSetters()]
6373
6374	def ReplaceStringInAllPaths(self, stringToReplace: str, newString: str) -> RundeckBulkUpdateStatus:
6375		return RundeckBulkUpdateStatus[self._Entity.ReplaceStringInAllPaths(stringToReplace, newString).ToString()]
6376
6377	def __getitem__(self, index: int):
6378		return self.RundeckColList[index]
6379
6380	def __iter__(self):
6381		yield from self.RundeckColList
6382
6383	def __len__(self):
6384		return len(self.RundeckColList)
6385
6386
6387class SectionCutCol(IdNameEntityCol[SectionCut]):
6388	def __init__(self, sectionCutCol: _api.SectionCutCol):
6389		self._Entity = sectionCutCol
6390		self._CollectedClass = SectionCut
6391
6392	@property
6393	def SectionCutColList(self) -> tuple[SectionCut]:
6394		return tuple([SectionCut(sectionCutCol) for sectionCutCol in self._Entity])
6395
6396	def Create(self, origin: Vector3d, normal: Vector3d, horizontal: Vector3d, name: str = None) -> SectionCut:
6397		return SectionCut(self._Entity.Create(origin._Entity, normal._Entity, horizontal._Entity, name))
6398
6399	def Delete(self, id: int) -> CollectionModificationStatus:
6400		return CollectionModificationStatus[self._Entity.Delete(id).ToString()]
6401
6402	@overload
6403	def Get(self, name: str) -> SectionCut: ...
6404
6405	@overload
6406	def Get(self, id: int) -> SectionCut: ...
6407
6408	def Get(self, item1 = None) -> SectionCut:
6409		if isinstance(item1, str):
6410			return SectionCut(super().Get(item1))
6411
6412		if isinstance(item1, int):
6413			return SectionCut(super().Get(item1))
6414
6415		return SectionCut(self._Entity.Get(item1))
6416
6417	def __getitem__(self, index: int):
6418		return self.SectionCutColList[index]
6419
6420	def __iter__(self):
6421		yield from self.SectionCutColList
6422
6423	def __len__(self):
6424		return len(self.SectionCutColList)
6425
6426
6427class SetCol(ZoneJointContainerCol[Set]):
6428	def __init__(self, setCol: _api.SetCol):
6429		self._Entity = setCol
6430		self._CollectedClass = Set
6431
6432	@property
6433	def SetColList(self) -> tuple[Set]:
6434		return tuple([Set(setCol) for setCol in self._Entity])
6435
6436	def Create(self, name: str = None) -> Set:
6437		return Set(self._Entity.Create(name))
6438
6439	@overload
6440	def Get(self, name: str) -> Set: ...
6441
6442	@overload
6443	def Get(self, id: int) -> Set: ...
6444
6445	def Get(self, item1 = None) -> Set:
6446		if isinstance(item1, str):
6447			return Set(super().Get(item1))
6448
6449		if isinstance(item1, int):
6450			return Set(super().Get(item1))
6451
6452		return Set(self._Entity.Get(item1))
6453
6454	def __getitem__(self, index: int):
6455		return self.SetColList[index]
6456
6457	def __iter__(self):
6458		yield from self.SetColList
6459
6460	def __len__(self):
6461		return len(self.SetColList)
6462
6463
6464class StructureCol(ZoneJointContainerCol[Structure]):
6465	def __init__(self, structureCol: _api.StructureCol):
6466		self._Entity = structureCol
6467		self._CollectedClass = Structure
6468
6469	@property
6470	def StructureColList(self) -> tuple[Structure]:
6471		return tuple([Structure(structureCol) for structureCol in self._Entity])
6472
6473	def Create(self, name: str = None) -> Structure:
6474		return Structure(self._Entity.Create(name))
6475
6476	@overload
6477	def DeleteStructure(self, structure: Structure) -> bool: ...
6478
6479	@overload
6480	def DeleteStructure(self, name: str) -> bool: ...
6481
6482	@overload
6483	def DeleteStructure(self, id: int) -> bool: ...
6484
6485	@overload
6486	def Get(self, name: str) -> Structure: ...
6487
6488	@overload
6489	def Get(self, id: int) -> Structure: ...
6490
6491	def DeleteStructure(self, item1 = None) -> bool:
6492		if isinstance(item1, Structure):
6493			return self._Entity.DeleteStructure(item1._Entity)
6494
6495		if isinstance(item1, str):
6496			return self._Entity.DeleteStructure(item1)
6497
6498		if isinstance(item1, int):
6499			return self._Entity.DeleteStructure(item1)
6500
6501		return self._Entity.DeleteStructure(item1._Entity)
6502
6503	def Get(self, item1 = None) -> Structure:
6504		if isinstance(item1, str):
6505			return Structure(super().Get(item1))
6506
6507		if isinstance(item1, int):
6508			return Structure(super().Get(item1))
6509
6510		return Structure(self._Entity.Get(item1))
6511
6512	def __getitem__(self, index: int):
6513		return self.StructureColList[index]
6514
6515	def __iter__(self):
6516		yield from self.StructureColList
6517
6518	def __len__(self):
6519		return len(self.StructureColList)
6520
6521
6522class Project:
6523	'''
6524	Represents a HyperX project within a database.
6525	'''
6526	def __init__(self, project: _api.Project):
6527		self._Entity = project
6528
6529	@property
6530	def HyperFea(self) -> HyperFea:
6531		result = self._Entity.HyperFea
6532		return HyperFea(result) if result is not None else None
6533
6534	@property
6535	def WorkingFolder(self) -> str:
6536		return self._Entity.WorkingFolder
6537
6538	@property
6539	def FemDataSet(self) -> FemDataSet:
6540		result = self._Entity.FemDataSet
6541		return FemDataSet(result) if result is not None else None
6542
6543	@property
6544	def Beams(self) -> ZoneCol:
6545		result = self._Entity.Beams
6546		return ZoneCol(result) if result is not None else None
6547
6548	@property
6549	def Id(self) -> int:
6550		return self._Entity.Id
6551
6552	@property
6553	def Joints(self) -> JointCol:
6554		result = self._Entity.Joints
6555		return JointCol(result) if result is not None else None
6556
6557	@property
6558	def Name(self) -> str:
6559		return self._Entity.Name
6560
6561	@property
6562	def Panels(self) -> ZoneCol:
6563		result = self._Entity.Panels
6564		return ZoneCol(result) if result is not None else None
6565
6566	@property
6567	def Rundecks(self) -> RundeckCol:
6568		result = self._Entity.Rundecks
6569		return RundeckCol(result) if result is not None else None
6570
6571	@property
6572	def Sets(self) -> SetCol:
6573		result = self._Entity.Sets
6574		return SetCol(result) if result is not None else None
6575
6576	@property
6577	def Structures(self) -> StructureCol:
6578		result = self._Entity.Structures
6579		return StructureCol(result) if result is not None else None
6580
6581	@property
6582	def Zones(self) -> ZoneCol:
6583		result = self._Entity.Zones
6584		return ZoneCol(result) if result is not None else None
6585
6586	@property
6587	def PanelSegments(self) -> PanelSegmentCol:
6588		result = self._Entity.PanelSegments
6589		return PanelSegmentCol(result) if result is not None else None
6590
6591	@property
6592	def SectionCuts(self) -> SectionCutCol:
6593		result = self._Entity.SectionCuts
6594		return SectionCutCol(result) if result is not None else None
6595
6596	@property
6597	def DesignLoads(self) -> DesignLoadCol:
6598		result = self._Entity.DesignLoads
6599		return DesignLoadCol(result) if result is not None else None
6600
6601	@property
6602	def DiscreteFieldTables(self) -> DiscreteFieldCol:
6603		result = self._Entity.DiscreteFieldTables
6604		return DiscreteFieldCol(result) if result is not None else None
6605
6606	@property
6607	def AnalysisProperties(self) -> AnalysisPropertyCol:
6608		result = self._Entity.AnalysisProperties
6609		return AnalysisPropertyCol(result) if result is not None else None
6610
6611	@property
6612	def DesignProperties(self) -> DesignPropertyCol:
6613		result = self._Entity.DesignProperties
6614		return DesignPropertyCol(result) if result is not None else None
6615
6616	@property
6617	def LoadProperties(self) -> LoadPropertyCol:
6618		result = self._Entity.LoadProperties
6619		return LoadPropertyCol(result) if result is not None else None
6620
6621	@property
6622	def FemFormat(self) -> types.ProjectModelFormat:
6623		return types.ProjectModelFormat[self._Entity.FemFormat.ToString()]
6624
6625	def Upload(self, uploadSetName: str, company: str, program: str, tags: list[str], notes: str, zoneIds: set[int], jointIds: set[int]) -> bool:
6626		tagsList = List[str]()
6627		if tags is not None:
6628			for thing in tags:
6629				if thing is not None:
6630					tagsList.Add(thing)
6631		zoneIdsSet = HashSet[int]()
6632		if zoneIds is not None:
6633			for thing in zoneIds:
6634				if thing is not None:
6635					zoneIdsSet.Add(thing)
6636		jointIdsSet = HashSet[int]()
6637		if jointIds is not None:
6638			for thing in jointIds:
6639				if thing is not None:
6640					jointIdsSet.Add(thing)
6641		return self._Entity.Upload(uploadSetName, company, program, tagsList, notes, zoneIdsSet, jointIdsSet)
6642
6643	def GetDashboardCompanies(self) -> list[str]:
6644		'''
6645		This method fetches an array of Dashboard company names that are available to the user who is currently logged in. The URL and authentication token are taken from the last
6646            Dashboard login made through HyperX.
6647		'''
6648		return list[str](self._Entity.GetDashboardCompanies())
6649
6650	def GetDashboardPrograms(self, companyName: str) -> list[str]:
6651		return list[str](self._Entity.GetDashboardPrograms(companyName))
6652
6653	def GetDashboardTags(self, companyName: str) -> list[str]:
6654		return list[str](self._Entity.GetDashboardTags(companyName))
6655
6656	def Dispose(self) -> None:
6657		return self._Entity.Dispose()
6658
6659	def ImportFem(self) -> None:
6660		return self._Entity.ImportFem()
6661
6662	def ImportFeaResults(self, alwaysImport: bool = False) -> str:
6663		return self._Entity.ImportFeaResults(alwaysImport)
6664
6665	def SetFemFormat(self, femFormat: types.ProjectModelFormat) -> None:
6666		return self._Entity.SetFemFormat(_types.ProjectModelFormat(femFormat.value))
6667
6668	def SetFemUnits(self, femForceId: DbForceUnit, femLengthId: DbLengthUnit, femMassId: DbMassUnit, femTemperatureId: DbTemperatureUnit) -> SetUnitsStatus:
6669		return SetUnitsStatus[self._Entity.SetFemUnits(_api.DbForceUnit(femForceId.value), _api.DbLengthUnit(femLengthId.value), _api.DbMassUnit(femMassId.value), _api.DbTemperatureUnit(femTemperatureId.value)).ToString()]
6670
6671	def SizeJoints(self, joints: list[Joint] = None) -> types.SimpleStatus:
6672		jointsList = List[_api.Joint]()
6673		if joints is not None:
6674			for thing in joints:
6675				if thing is not None:
6676					jointsList.Add(thing._Entity)
6677		return types.SimpleStatus(self._Entity.SizeJoints(joints if joints is None else jointsList))
6678
6679	def GetJointsWithoutResults(self, joints: list[Joint]) -> set[int]:
6680		jointsList = List[_api.Joint]()
6681		if joints is not None:
6682			for thing in joints:
6683				if thing is not None:
6684					jointsList.Add(thing._Entity)
6685		return set[int](self._Entity.GetJointsWithoutResults(jointsList))
6686
6687	@overload
6688	def AnalyzeZones(self, zones: list[Zone] = None) -> types.SimpleStatus: ...
6689
6690	@overload
6691	def AnalyzeZones(self, zoneIds: list[int]) -> types.SimpleStatus: ...
6692
6693	@overload
6694	def SizeZones(self, zones: list[Zone] = None) -> types.SimpleStatus: ...
6695
6696	@overload
6697	def SizeZones(self, zoneIds: list[int]) -> types.SimpleStatus: ...
6698
6699	def CreateNonFeaZone(self, category: types.FamilyCategory, name: str = None) -> Zone:
6700		result = self._Entity.CreateNonFeaZone(_types.FamilyCategory(category.value), name)
6701		thisClass = type(result).__name__
6702		givenClass = Zone
6703		for subclass in Zone.__subclasses__():
6704			if subclass.__name__ == thisClass:
6705				givenClass = subclass
6706		return givenClass(result)
6707
6708	def ReturnToUnusedFem(self, zoneNumbers: list[int] = None, jointIds: set[int] = None) -> None:
6709		zoneNumbersList = MakeCSharpIntList(zoneNumbers)
6710		jointIdsSet = HashSet[int]()
6711		if jointIds is not None:
6712			for thing in jointIds:
6713				if thing is not None:
6714					jointIdsSet.Add(thing)
6715		return self._Entity.ReturnToUnusedFem(zoneNumbers if zoneNumbers is None else zoneNumbersList, jointIds if jointIds is None else jointIdsSet)
6716
6717	def UnimportFemAsync(self) -> Task:
6718		return Task(self._Entity.UnimportFemAsync())
6719
6720	def ExportFem(self, destinationFolder: str) -> None:
6721		return self._Entity.ExportFem(destinationFolder)
6722
6723	def ImportCad(self, filePath: str) -> None:
6724		return self._Entity.ImportCad(filePath)
6725
6726	@overload
6727	def ExportCad(self, filePath: str) -> None: ...
6728
6729	@overload
6730	def ExportCad(self, cadIds: tuple[int], filePath: str) -> None: ...
6731
6732	def RegeneratePfem(self) -> None:
6733		'''
6734		Regenerates and displays the preview FEM. If running a script outside of the Script Runner,
6735            do not call this method
6736		'''
6737		return self._Entity.RegeneratePfem()
6738
6739	def AnalyzeZones(self, item1 = None) -> types.SimpleStatus:
6740		if isinstance(item1, list) and item1 and isinstance(item1[0], Zone):
6741			zonesList = List[_api.Zone]()
6742			if item1 is not None:
6743				for thing in item1:
6744					if thing is not None:
6745						zonesList.Add(thing._Entity)
6746			return types.SimpleStatus(self._Entity.AnalyzeZones(item1 if item1 is None else zonesList))
6747
6748		if isinstance(item1, list) and item1 and isinstance(item1[0], int):
6749			zoneIdsList = MakeCSharpIntList(item1)
6750			return types.SimpleStatus(self._Entity.AnalyzeZones(zoneIdsList))
6751
6752		return types.SimpleStatus(self._Entity.AnalyzeZones(item1))
6753
6754	def SizeZones(self, item1 = None) -> types.SimpleStatus:
6755		if isinstance(item1, list) and item1 and isinstance(item1[0], Zone):
6756			zonesList = List[_api.Zone]()
6757			if item1 is not None:
6758				for thing in item1:
6759					if thing is not None:
6760						zonesList.Add(thing._Entity)
6761			return types.SimpleStatus(self._Entity.SizeZones(item1 if item1 is None else zonesList))
6762
6763		if isinstance(item1, list) and item1 and isinstance(item1[0], int):
6764			zoneIdsList = MakeCSharpIntList(item1)
6765			return types.SimpleStatus(self._Entity.SizeZones(zoneIdsList))
6766
6767		return types.SimpleStatus(self._Entity.SizeZones(item1))
6768
6769	def ExportCad(self, item1 = None, item2 = None) -> None:
6770		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int) and isinstance(item2, str):
6771			cadIdsList = MakeCSharpIntList(item1)
6772			cadIdsEnumerable = IEnumerable(cadIdsList)
6773			return self._Entity.ExportCad(cadIdsEnumerable, item2)
6774
6775		if isinstance(item1, str):
6776			return self._Entity.ExportCad(item1)
6777
6778		return self._Entity.ExportCad(item1, item2)
6779
6780
6781class ProjectInfo(IdNameEntityRenameable):
6782	def __init__(self, projectInfo: _api.ProjectInfo):
6783		self._Entity = projectInfo
6784
6785
6786class FailureModeCategoryCol(IdNameEntityCol[FailureModeCategory]):
6787	def __init__(self, failureModeCategoryCol: _api.FailureModeCategoryCol):
6788		self._Entity = failureModeCategoryCol
6789		self._CollectedClass = FailureModeCategory
6790
6791	@property
6792	def FailureModeCategoryColList(self) -> tuple[FailureModeCategory]:
6793		return tuple([FailureModeCategory(failureModeCategoryCol) for failureModeCategoryCol in self._Entity])
6794
6795	@overload
6796	def Get(self, name: str) -> FailureModeCategory: ...
6797
6798	@overload
6799	def Get(self, id: int) -> FailureModeCategory: ...
6800
6801	def Get(self, item1 = None) -> FailureModeCategory:
6802		if isinstance(item1, str):
6803			return FailureModeCategory(super().Get(item1))
6804
6805		if isinstance(item1, int):
6806			return FailureModeCategory(super().Get(item1))
6807
6808		return FailureModeCategory(self._Entity.Get(item1))
6809
6810	def __getitem__(self, index: int):
6811		return self.FailureModeCategoryColList[index]
6812
6813	def __iter__(self):
6814		yield from self.FailureModeCategoryColList
6815
6816	def __len__(self):
6817		return len(self.FailureModeCategoryColList)
6818
6819
6820class FoamCol(Generic[T]):
6821	def __init__(self, foamCol: _api.FoamCol):
6822		self._Entity = foamCol
6823
6824	@property
6825	def FoamColList(self) -> tuple[Foam]:
6826		return tuple([Foam(foamCol) for foamCol in self._Entity])
6827
6828	def Count(self) -> int:
6829		return self._Entity.Count()
6830
6831	def Get(self, materialName: str) -> Foam:
6832		return Foam(self._Entity.Get(materialName))
6833
6834	def Contains(self, materialName: str) -> bool:
6835		return self._Entity.Contains(materialName)
6836
6837	def Create(self, materialFamilyName: str, density: float, newMaterialName: str = None, femId: int = None) -> Foam:
6838		return Foam(self._Entity.Create(materialFamilyName, density, newMaterialName, femId))
6839
6840	def Copy(self, fmToCopyName: str, newMaterialName: str = None, femId: int = None) -> Foam:
6841		return Foam(self._Entity.Copy(fmToCopyName, newMaterialName, femId))
6842
6843	def Delete(self, materialName: str) -> bool:
6844		return self._Entity.Delete(materialName)
6845
6846	def __getitem__(self, index: int):
6847		return self.FoamColList[index]
6848
6849	def __iter__(self):
6850		yield from self.FoamColList
6851
6852	def __len__(self):
6853		return len(self.FoamColList)
6854
6855
6856class HoneycombCol(Generic[T]):
6857	def __init__(self, honeycombCol: _api.HoneycombCol):
6858		self._Entity = honeycombCol
6859
6860	@property
6861	def HoneycombColList(self) -> tuple[Honeycomb]:
6862		return tuple([Honeycomb(honeycombCol) for honeycombCol in self._Entity])
6863
6864	def Count(self) -> int:
6865		return self._Entity.Count()
6866
6867	def Get(self, materialName: str) -> Honeycomb:
6868		return Honeycomb(self._Entity.Get(materialName))
6869
6870	def Contains(self, materialName: str) -> bool:
6871		return self._Entity.Contains(materialName)
6872
6873	def Create(self, materialFamilyName: str, density: float, newMaterialName: str = None, femId: int = None) -> Honeycomb:
6874		return Honeycomb(self._Entity.Create(materialFamilyName, density, newMaterialName, femId))
6875
6876	def Copy(self, honeyToCopyName: str, newMaterialName: str = None, femId: int = None) -> Honeycomb:
6877		return Honeycomb(self._Entity.Copy(honeyToCopyName, newMaterialName, femId))
6878
6879	def Delete(self, materialName: str) -> bool:
6880		return self._Entity.Delete(materialName)
6881
6882	def __getitem__(self, index: int):
6883		return self.HoneycombColList[index]
6884
6885	def __iter__(self):
6886		yield from self.HoneycombColList
6887
6888	def __len__(self):
6889		return len(self.HoneycombColList)
6890
6891
6892class IsotropicCol(Generic[T]):
6893	def __init__(self, isotropicCol: _api.IsotropicCol):
6894		self._Entity = isotropicCol
6895
6896	@property
6897	def IsotropicColList(self) -> tuple[Isotropic]:
6898		return tuple([Isotropic(isotropicCol) for isotropicCol in self._Entity])
6899
6900	def Count(self) -> int:
6901		return self._Entity.Count()
6902
6903	def Get(self, materialName: str) -> Isotropic:
6904		return Isotropic(self._Entity.Get(materialName))
6905
6906	def Contains(self, materialName: str) -> bool:
6907		return self._Entity.Contains(materialName)
6908
6909	def Create(self, materialFamilyName: str, density: float, newMaterialName: str = None, femId: int = None) -> Isotropic:
6910		return Isotropic(self._Entity.Create(materialFamilyName, density, newMaterialName, femId))
6911
6912	def Copy(self, isoToCopyName: str, newMaterialName: str = None, femId: int = None) -> Isotropic:
6913		return Isotropic(self._Entity.Copy(isoToCopyName, newMaterialName, femId))
6914
6915	def Delete(self, materialName: str) -> bool:
6916		return self._Entity.Delete(materialName)
6917
6918	def __getitem__(self, index: int):
6919		return self.IsotropicColList[index]
6920
6921	def __iter__(self):
6922		yield from self.IsotropicColList
6923
6924	def __len__(self):
6925		return len(self.IsotropicColList)
6926
6927
6928class LaminateFamilyCol(IdNameEntityCol[LaminateFamily]):
6929	def __init__(self, laminateFamilyCol: _api.LaminateFamilyCol):
6930		self._Entity = laminateFamilyCol
6931		self._CollectedClass = LaminateFamily
6932
6933	@property
6934	def LaminateFamilyColList(self) -> tuple[LaminateFamily]:
6935		return tuple([LaminateFamily(laminateFamilyCol) for laminateFamilyCol in self._Entity])
6936
6937	@overload
6938	def Get(self, name: str) -> LaminateFamily: ...
6939
6940	@overload
6941	def Get(self, id: int) -> LaminateFamily: ...
6942
6943	def Get(self, item1 = None) -> LaminateFamily:
6944		if isinstance(item1, str):
6945			return LaminateFamily(super().Get(item1))
6946
6947		if isinstance(item1, int):
6948			return LaminateFamily(super().Get(item1))
6949
6950		return LaminateFamily(self._Entity.Get(item1))
6951
6952	def __getitem__(self, index: int):
6953		return self.LaminateFamilyColList[index]
6954
6955	def __iter__(self):
6956		yield from self.LaminateFamilyColList
6957
6958	def __len__(self):
6959		return len(self.LaminateFamilyColList)
6960
6961
6962class LaminateCol(Generic[T]):
6963	def __init__(self, laminateCol: _api.LaminateCol):
6964		self._Entity = laminateCol
6965
6966	@property
6967	def LaminateColList(self) -> tuple[Laminate]:
6968		return tuple([Laminate(laminateCol) for laminateCol in self._Entity])
6969
6970	def Count(self) -> int:
6971		return self._Entity.Count()
6972
6973	def Get(self, laminateName: str) -> LaminateBase:
6974		result = self._Entity.Get(laminateName)
6975		thisClass = type(result).__name__
6976		givenClass = LaminateBase
6977		for subclass in LaminateBase.__subclasses__():
6978			if subclass.__name__ == thisClass:
6979				givenClass = subclass
6980		return givenClass(result)
6981
6982	def Contains(self, laminateName: str) -> bool:
6983		return self._Entity.Contains(laminateName)
6984
6985	def CreateLaminate(self, materialFamily: str, laminateName: str = None) -> Laminate:
6986		return Laminate(self._Entity.CreateLaminate(materialFamily, laminateName))
6987
6988	def CreateStiffenerLaminate(self, materialFamily: str, stiffenerProfile: types.StiffenerProfile, laminateName: str = None) -> StiffenerLaminate:
6989		return StiffenerLaminate(self._Entity.CreateStiffenerLaminate(materialFamily, _types.StiffenerProfile(stiffenerProfile.value), laminateName))
6990
6991	def Copy(self, laminateToCopyName: str, newLaminateName: str = None) -> LaminateBase:
6992		result = self._Entity.Copy(laminateToCopyName, newLaminateName)
6993		thisClass = type(result).__name__
6994		givenClass = LaminateBase
6995		for subclass in LaminateBase.__subclasses__():
6996			if subclass.__name__ == thisClass:
6997				givenClass = subclass
6998		return givenClass(result)
6999
7000	def Delete(self, name: str) -> bool:
7001		return self._Entity.Delete(name)
7002
7003	def GetLaminate(self, name: str) -> Laminate:
7004		return Laminate(self._Entity.GetLaminate(name))
7005
7006	def GetStiffenerLaminate(self, name: str) -> StiffenerLaminate:
7007		return StiffenerLaminate(self._Entity.GetStiffenerLaminate(name))
7008
7009	def __getitem__(self, index: int):
7010		return self.LaminateColList[index]
7011
7012	def __iter__(self):
7013		yield from self.LaminateColList
7014
7015	def __len__(self):
7016		return len(self.LaminateColList)
7017
7018
7019class OrthotropicCol(Generic[T]):
7020	def __init__(self, orthotropicCol: _api.OrthotropicCol):
7021		self._Entity = orthotropicCol
7022
7023	@property
7024	def OrthotropicColList(self) -> tuple[Orthotropic]:
7025		return tuple([Orthotropic(orthotropicCol) for orthotropicCol in self._Entity])
7026
7027	def Count(self) -> int:
7028		return self._Entity.Count()
7029
7030	def Get(self, materialName: str) -> Orthotropic:
7031		return Orthotropic(self._Entity.Get(materialName))
7032
7033	def Contains(self, materialName: str) -> bool:
7034		return self._Entity.Contains(materialName)
7035
7036	def Create(self, materialFamilyName: str, thickness: float, density: float, newMaterialName: str = None, femId: int = None) -> Orthotropic:
7037		return Orthotropic(self._Entity.Create(materialFamilyName, thickness, density, newMaterialName, femId))
7038
7039	def Copy(self, orthoToCopyName: str, newMaterialName: str = None, femId: int = None) -> Orthotropic:
7040		return Orthotropic(self._Entity.Copy(orthoToCopyName, newMaterialName, femId))
7041
7042	def Delete(self, materialName: str) -> bool:
7043		return self._Entity.Delete(materialName)
7044
7045	def __getitem__(self, index: int):
7046		return self.OrthotropicColList[index]
7047
7048	def __iter__(self):
7049		yield from self.OrthotropicColList
7050
7051	def __len__(self):
7052		return len(self.OrthotropicColList)
7053
7054
7055class PluginPackageCol(IdNameEntityCol[PluginPackage]):
7056	def __init__(self, pluginPackageCol: _api.PluginPackageCol):
7057		self._Entity = pluginPackageCol
7058		self._CollectedClass = PluginPackage
7059
7060	@property
7061	def PluginPackageColList(self) -> tuple[PluginPackage]:
7062		return tuple([PluginPackage(pluginPackageCol) for pluginPackageCol in self._Entity])
7063
7064	def AddPluginPackage(self, path: str) -> PluginPackage:
7065		return PluginPackage(self._Entity.AddPluginPackage(path))
7066
7067	@overload
7068	def RemovePluginPackage(self, name: str) -> bool: ...
7069
7070	@overload
7071	def RemovePluginPackage(self, id: int) -> bool: ...
7072
7073	def ClearAllPluginPackages(self) -> None:
7074		'''
7075		Clears all packages out of the database
7076		'''
7077		return self._Entity.ClearAllPluginPackages()
7078
7079	def GetPluginPackages(self) -> list[PluginPackage]:
7080		'''
7081		Gets a list of package info
7082            Includes name, id, file path, version, description, and modification date
7083		'''
7084		return [PluginPackage(pluginPackage) for pluginPackage in self._Entity.GetPluginPackages()]
7085
7086	@overload
7087	def Get(self, name: str) -> PluginPackage: ...
7088
7089	@overload
7090	def Get(self, id: int) -> PluginPackage: ...
7091
7092	def RemovePluginPackage(self, item1 = None) -> bool:
7093		if isinstance(item1, str):
7094			return self._Entity.RemovePluginPackage(item1)
7095
7096		if isinstance(item1, int):
7097			return self._Entity.RemovePluginPackage(item1)
7098
7099		return self._Entity.RemovePluginPackage(item1)
7100
7101	def Get(self, item1 = None) -> PluginPackage:
7102		if isinstance(item1, str):
7103			return PluginPackage(super().Get(item1))
7104
7105		if isinstance(item1, int):
7106			return PluginPackage(super().Get(item1))
7107
7108		return PluginPackage(self._Entity.Get(item1))
7109
7110	def __getitem__(self, index: int):
7111		return self.PluginPackageColList[index]
7112
7113	def __iter__(self):
7114		yield from self.PluginPackageColList
7115
7116	def __len__(self):
7117		return len(self.PluginPackageColList)
7118
7119
7120class ProjectInfoCol(IdNameEntityCol[ProjectInfo]):
7121	def __init__(self, projectInfoCol: _api.ProjectInfoCol):
7122		self._Entity = projectInfoCol
7123		self._CollectedClass = ProjectInfo
7124
7125	@property
7126	def ProjectInfoColList(self) -> tuple[ProjectInfo]:
7127		return tuple([ProjectInfo(projectInfoCol) for projectInfoCol in self._Entity])
7128
7129	@overload
7130	def Get(self, name: str) -> ProjectInfo: ...
7131
7132	@overload
7133	def Get(self, id: int) -> ProjectInfo: ...
7134
7135	def Get(self, item1 = None) -> ProjectInfo:
7136		if isinstance(item1, str):
7137			return ProjectInfo(super().Get(item1))
7138
7139		if isinstance(item1, int):
7140			return ProjectInfo(super().Get(item1))
7141
7142		return ProjectInfo(self._Entity.Get(item1))
7143
7144	def __getitem__(self, index: int):
7145		return self.ProjectInfoColList[index]
7146
7147	def __iter__(self):
7148		yield from self.ProjectInfoColList
7149
7150	def __len__(self):
7151		return len(self.ProjectInfoColList)
7152
7153
7154class Application:
7155	'''
7156	HyperX scripting application.
7157            This API is not guaranteed to be thread-safe.
7158            Calls into a single application instance or its descendents are not safe to be called concurrently.
7159            
7160            However, it is safe enough for integration testing to have multiple
7161            application instances with a single process.
7162	'''
7163	def __init__(self, application: _api.Application):
7164		self._Entity = application
7165
7166	@property
7167	def UnitSystem(self) -> UnitSystem:
7168		'''
7169		Unit system specified when starting a scripting Application.
7170		'''
7171		result = self._Entity.UnitSystem
7172		return UnitSystem(result) if result is not None else None
7173
7174	@property
7175	def CompilationDate(self) -> str:
7176		return self._Entity.CompilationDate
7177
7178	@property
7179	def DatabasePath(self) -> str:
7180		return self._Entity.DatabasePath
7181
7182	@property
7183	def ActiveProject(self) -> Project:
7184		'''
7185		Represents a HyperX project within a database.
7186		'''
7187		result = self._Entity.ActiveProject
7188		return Project(result) if result is not None else None
7189
7190	@property
7191	def UiRunnerMode(self) -> bool:
7192		return self._Entity.UiRunnerMode
7193
7194	@property
7195	def Version(self) -> str:
7196		return self._Entity.Version
7197
7198	@property
7199	def FailureModeCategories(self) -> FailureModeCategoryCol:
7200		result = self._Entity.FailureModeCategories
7201		return FailureModeCategoryCol(result) if result is not None else None
7202
7203	@property
7204	def FailureModes(self) -> FailureModeCol:
7205		result = self._Entity.FailureModes
7206		return FailureModeCol(result) if result is not None else None
7207
7208	@property
7209	def Packages(self) -> PluginPackageCol:
7210		result = self._Entity.Packages
7211		return PluginPackageCol(result) if result is not None else None
7212
7213	@property
7214	def Foams(self) -> FoamCol:
7215		'''
7216		Contains a set of all foam materials in a database.
7217		'''
7218		result = self._Entity.Foams
7219		return FoamCol(result) if result is not None else None
7220
7221	@property
7222	def Honeycombs(self) -> HoneycombCol:
7223		'''
7224		Contains a set of all honeycomb materials in a database.
7225		'''
7226		result = self._Entity.Honeycombs
7227		return HoneycombCol(result) if result is not None else None
7228
7229	@property
7230	def Isotropics(self) -> IsotropicCol:
7231		'''
7232		Contains a set of all isotropic materials in a database.
7233		'''
7234		result = self._Entity.Isotropics
7235		return IsotropicCol(result) if result is not None else None
7236
7237	@property
7238	def Laminates(self) -> LaminateCol:
7239		result = self._Entity.Laminates
7240		return LaminateCol(result) if result is not None else None
7241
7242	@property
7243	def LaminateFamilies(self) -> LaminateFamilyCol:
7244		result = self._Entity.LaminateFamilies
7245		return LaminateFamilyCol(result) if result is not None else None
7246
7247	@property
7248	def AnalysisProperties(self) -> AnalysisPropertyCol:
7249		result = self._Entity.AnalysisProperties
7250		return AnalysisPropertyCol(result) if result is not None else None
7251
7252	@property
7253	def DesignProperties(self) -> DesignPropertyCol:
7254		result = self._Entity.DesignProperties
7255		return DesignPropertyCol(result) if result is not None else None
7256
7257	@property
7258	def LoadProperties(self) -> LoadPropertyCol:
7259		result = self._Entity.LoadProperties
7260		return LoadPropertyCol(result) if result is not None else None
7261
7262	@property
7263	def Orthotropics(self) -> OrthotropicCol:
7264		'''
7265		Contains a set of all orthotropic materials in a database.
7266		'''
7267		result = self._Entity.Orthotropics
7268		return OrthotropicCol(result) if result is not None else None
7269
7270	@property
7271	def ProjectInfos(self) -> ProjectInfoCol:
7272		'''
7273		Contains a set of all projects in a database.
7274		'''
7275		result = self._Entity.ProjectInfos
7276		return ProjectInfoCol(result) if result is not None else None
7277
7278	@property
7279	def UserName(self) -> str:
7280		return self._Entity.UserName
7281
7282	@UserName.setter
7283	def UserName(self, value: str) -> None:
7284		self._Entity.UserName = value
7285
7286	def CloseDatabase(self, delay: int = 0) -> None:
7287		return self._Entity.CloseDatabase(delay)
7288
7289	def CopyProject(self, projectId: int, newName: str = None, copyDesignProperties: bool = True, copyAnalysisProperties: bool = True, copyLoadProperties: bool = True, copyWorkingFolder: bool = True) -> ProjectInfo:
7290		return ProjectInfo(self._Entity.CopyProject(projectId, newName, copyDesignProperties, copyAnalysisProperties, copyLoadProperties, copyWorkingFolder))
7291
7292	def CreateDatabaseFromTemplate(self, templateName: str, newPath: str) -> None:
7293		return self._Entity.CreateDatabaseFromTemplate(templateName, newPath)
7294
7295	def CreateProject(self, projectName: str = None) -> ProjectInfo:
7296		return ProjectInfo(self._Entity.CreateProject(projectName))
7297
7298	def DeleteProject(self, projectName: str) -> ProjectDeletionStatus:
7299		return ProjectDeletionStatus[self._Entity.DeleteProject(projectName).ToString()]
7300
7301	def Dispose(self) -> None:
7302		'''
7303		Dispose of the application. Should be explicitly called after the application
7304            is no longer needed unless the application is wrapped with a using clause.
7305		'''
7306		return self._Entity.Dispose()
7307
7308	def GetAnalyses(self) -> dict[int, AnalysisDefinition]:
7309		'''
7310		Get all Analysis Definitions in the database.
7311		'''
7312		return dict[int, AnalysisDefinition](self._Entity.GetAnalyses())
7313
7314	def Login(self, userName: str, password: str = "") -> None:
7315		return self._Entity.Login(userName, password)
7316
7317	def Migrate(self, databasePath: str) -> str:
7318		return self._Entity.Migrate(databasePath)
7319
7320	def CheckDatabaseIsUpToDate(self, databasePath: str) -> bool:
7321		return self._Entity.CheckDatabaseIsUpToDate(databasePath)
7322
7323	def OpenDatabase(self, databasePath: str) -> None:
7324		return self._Entity.OpenDatabase(databasePath)
7325
7326	def SelectProject(self, projectName: str) -> Project:
7327		return Project(self._Entity.SelectProject(projectName))
7328
7329
7330class JointDesignProperty(DesignProperty):
7331	def __init__(self, jointDesignProperty: _api.JointDesignProperty):
7332		self._Entity = jointDesignProperty
7333
7334
7335class SizingMaterial(IdEntity):
7336	def __init__(self, sizingMaterial: _api.SizingMaterial):
7337		self._Entity = sizingMaterial
7338
7339	@property
7340	def MaterialId(self) -> int:
7341		return self._Entity.MaterialId
7342
7343	@property
7344	def MaterialType(self) -> types.MaterialType:
7345		'''
7346		Represents a material's type.
7347		'''
7348		return types.MaterialType[self._Entity.MaterialType.ToString()]
7349
7350
7351class SizingMaterialCol(IdEntityCol[SizingMaterial]):
7352	def __init__(self, sizingMaterialCol: _api.SizingMaterialCol):
7353		self._Entity = sizingMaterialCol
7354		self._CollectedClass = SizingMaterial
7355
7356	@property
7357	def SizingMaterialColList(self) -> tuple[SizingMaterial]:
7358		return tuple([SizingMaterial(sizingMaterialCol) for sizingMaterialCol in self._Entity])
7359
7360	@overload
7361	def Get(self, name: str) -> SizingMaterial: ...
7362
7363	@overload
7364	def Contains(self, name: str) -> bool: ...
7365
7366	@overload
7367	def AddSizingMaterial(self, materialId: int) -> bool: ...
7368
7369	@overload
7370	def AddSizingMaterial(self, name: str) -> bool: ...
7371
7372	@overload
7373	def RemoveSizingMaterial(self, materialId: int) -> bool: ...
7374
7375	@overload
7376	def RemoveSizingMaterial(self, name: str) -> bool: ...
7377
7378	@overload
7379	def Contains(self, id: int) -> bool: ...
7380
7381	@overload
7382	def Get(self, id: int) -> SizingMaterial: ...
7383
7384	def Get(self, item1 = None) -> SizingMaterial:
7385		if isinstance(item1, str):
7386			return SizingMaterial(self._Entity.Get(item1))
7387
7388		if isinstance(item1, int):
7389			return SizingMaterial(super().Get(item1))
7390
7391		return SizingMaterial(self._Entity.Get(item1))
7392
7393	def Contains(self, item1 = None) -> bool:
7394		if isinstance(item1, str):
7395			return self._Entity.Contains(item1)
7396
7397		if isinstance(item1, int):
7398			return bool(super().Contains(item1))
7399
7400		return self._Entity.Contains(item1)
7401
7402	def AddSizingMaterial(self, item1 = None) -> bool:
7403		if isinstance(item1, int):
7404			return self._Entity.AddSizingMaterial(item1)
7405
7406		if isinstance(item1, str):
7407			return self._Entity.AddSizingMaterial(item1)
7408
7409		return self._Entity.AddSizingMaterial(item1)
7410
7411	def RemoveSizingMaterial(self, item1 = None) -> bool:
7412		if isinstance(item1, int):
7413			return self._Entity.RemoveSizingMaterial(item1)
7414
7415		if isinstance(item1, str):
7416			return self._Entity.RemoveSizingMaterial(item1)
7417
7418		return self._Entity.RemoveSizingMaterial(item1)
7419
7420	def __getitem__(self, index: int):
7421		return self.SizingMaterialColList[index]
7422
7423	def __iter__(self):
7424		yield from self.SizingMaterialColList
7425
7426	def __len__(self):
7427		return len(self.SizingMaterialColList)
7428
7429
7430class ZoneOverride(IdEntity):
7431	def __init__(self, zoneOverride: _api.ZoneOverride):
7432		self._Entity = zoneOverride
7433
7434	@property
7435	def AllowMaterials(self) -> bool:
7436		return self._Entity.AllowMaterials
7437
7438	@property
7439	def ProjectId(self) -> int:
7440		return self._Entity.ProjectId
7441
7442	@property
7443	def DesignId(self) -> int:
7444		return self._Entity.DesignId
7445
7446	@property
7447	def FamilyId(self) -> types.BeamPanelFamily:
7448		return types.BeamPanelFamily[self._Entity.FamilyId.ToString()]
7449
7450	@property
7451	def ConceptId(self) -> int:
7452		return self._Entity.ConceptId
7453
7454	@property
7455	def VariableId(self) -> int:
7456		return self._Entity.VariableId
7457
7458	@property
7459	def MinBound(self) -> float:
7460		return self._Entity.MinBound
7461
7462	@property
7463	def MaxBound(self) -> float:
7464		return self._Entity.MaxBound
7465
7466	@property
7467	def StepSize(self) -> float:
7468		return self._Entity.StepSize
7469
7470	@property
7471	def MinPlies(self) -> int:
7472		return self._Entity.MinPlies
7473
7474	@property
7475	def MaxPlies(self) -> int:
7476		return self._Entity.MaxPlies
7477
7478	@property
7479	def PlyStepSize(self) -> int:
7480		return self._Entity.PlyStepSize
7481
7482	@property
7483	def InputMode(self) -> types.VariableInputMode:
7484		return types.VariableInputMode[self._Entity.InputMode.ToString()]
7485
7486	@property
7487	def SizingMaterials(self) -> SizingMaterialCol:
7488		result = self._Entity.SizingMaterials
7489		return SizingMaterialCol(result) if result is not None else None
7490
7491	@property
7492	def AnalysisValue(self) -> float:
7493		return self._Entity.AnalysisValue
7494
7495	@property
7496	def AnalysisMaterial(self) -> str:
7497		return self._Entity.AnalysisMaterial
7498
7499	@property
7500	def AnalysisMaterialType(self) -> types.MaterialType:
7501		return types.MaterialType[self._Entity.AnalysisMaterialType.ToString()]
7502
7503	@MinBound.setter
7504	def MinBound(self, value: float) -> None:
7505		self._Entity.MinBound = value
7506
7507	@MaxBound.setter
7508	def MaxBound(self, value: float) -> None:
7509		self._Entity.MaxBound = value
7510
7511	@StepSize.setter
7512	def StepSize(self, value: float) -> None:
7513		self._Entity.StepSize = value
7514
7515	@MinPlies.setter
7516	def MinPlies(self, value: int) -> None:
7517		self._Entity.MinPlies = value
7518
7519	@MaxPlies.setter
7520	def MaxPlies(self, value: int) -> None:
7521		self._Entity.MaxPlies = value
7522
7523	@PlyStepSize.setter
7524	def PlyStepSize(self, value: int) -> None:
7525		self._Entity.PlyStepSize = value
7526
7527	@AnalysisValue.setter
7528	def AnalysisValue(self, value: float) -> None:
7529		self._Entity.AnalysisValue = value
7530
7531	@AnalysisMaterial.setter
7532	def AnalysisMaterial(self, value: str) -> None:
7533		self._Entity.AnalysisMaterial = value
7534
7535
7536class ToolingConstraint(IdNameEntity):
7537	'''
7538	Tooling constraints are a feature of Design Properties for Zones.
7539	'''
7540	def __init__(self, toolingConstraint: _api.ToolingConstraint):
7541		self._Entity = toolingConstraint
7542
7543	@property
7544	def ConstraintMax(self) -> float:
7545		return self._Entity.ConstraintMax
7546
7547	@property
7548	def ConstraintMin(self) -> float:
7549		return self._Entity.ConstraintMin
7550
7551	@property
7552	def ConstraintValue(self) -> float:
7553		return self._Entity.ConstraintValue
7554
7555	@property
7556	def ToolingSelectionType(self) -> types.ToolingSelectionType:
7557		'''
7558		Defines which selection a given tooling constraint is currently set to.
7559		'''
7560		return types.ToolingSelectionType[self._Entity.ToolingSelectionType.ToString()]
7561
7562	def SetToAnyValue(self) -> None:
7563		return self._Entity.SetToAnyValue()
7564
7565	def SetToInequality(self, value: float) -> None:
7566		return self._Entity.SetToInequality(value)
7567
7568	def SetToRange(self, min: float, max: float) -> None:
7569		return self._Entity.SetToRange(min, max)
7570
7571	def SetToValue(self, value: float) -> None:
7572		return self._Entity.SetToValue(value)
7573
7574
7575class ZoneOverrideCol(IdEntityCol[ZoneOverride]):
7576	def __init__(self, zoneOverrideCol: _api.ZoneOverrideCol):
7577		self._Entity = zoneOverrideCol
7578		self._CollectedClass = ZoneOverride
7579
7580	@property
7581	def ZoneOverrideColList(self) -> tuple[ZoneOverride]:
7582		return tuple([ZoneOverride(zoneOverrideCol) for zoneOverrideCol in self._Entity])
7583
7584	def Get(self, zoneNumber: int) -> ZoneOverride:
7585		return ZoneOverride(self._Entity.Get(zoneNumber))
7586
7587	def __getitem__(self, index: int):
7588		return self.ZoneOverrideColList[index]
7589
7590	def __iter__(self):
7591		yield from self.ZoneOverrideColList
7592
7593	def __len__(self):
7594		return len(self.ZoneOverrideColList)
7595
7596
7597class DesignVariable(IdEntity):
7598	'''
7599	Holds design variable data.
7600            Min, max, steps, materials.
7601	'''
7602	def __init__(self, designVariable: _api.DesignVariable):
7603		self._Entity = designVariable
7604
7605	@property
7606	def VariableParameter(self) -> types.VariableParameter:
7607		return types.VariableParameter[self._Entity.VariableParameter.ToString()]
7608
7609	@property
7610	def AllowMaterials(self) -> bool:
7611		return self._Entity.AllowMaterials
7612
7613	@property
7614	def Max(self) -> float:
7615		return self._Entity.Max
7616
7617	@property
7618	def Min(self) -> float:
7619		return self._Entity.Min
7620
7621	@property
7622	def Name(self) -> str:
7623		return self._Entity.Name
7624
7625	@property
7626	def StepSize(self) -> float:
7627		return self._Entity.StepSize
7628
7629	@property
7630	def UseAnalysis(self) -> bool:
7631		return self._Entity.UseAnalysis
7632
7633	@property
7634	def AnalysisMaterial(self) -> str:
7635		return self._Entity.AnalysisMaterial
7636
7637	@property
7638	def AnalysisMaterialType(self) -> types.MaterialType:
7639		return types.MaterialType[self._Entity.AnalysisMaterialType.ToString()]
7640
7641	@property
7642	def SizingMaterialType(self) -> types.MaterialType:
7643		return types.MaterialType[self._Entity.SizingMaterialType.ToString()]
7644
7645	@property
7646	def AnalysisValue(self) -> float:
7647		return self._Entity.AnalysisValue
7648
7649	@property
7650	def Overrides(self) -> ZoneOverrideCol:
7651		result = self._Entity.Overrides
7652		return ZoneOverrideCol(result) if result is not None else None
7653
7654	@Max.setter
7655	def Max(self, value: float) -> None:
7656		self._Entity.Max = value
7657
7658	@Min.setter
7659	def Min(self, value: float) -> None:
7660		self._Entity.Min = value
7661
7662	@StepSize.setter
7663	def StepSize(self, value: float) -> None:
7664		self._Entity.StepSize = value
7665
7666	@UseAnalysis.setter
7667	def UseAnalysis(self, value: bool) -> None:
7668		self._Entity.UseAnalysis = value
7669
7670	@AnalysisMaterial.setter
7671	def AnalysisMaterial(self, value: str) -> None:
7672		self._Entity.AnalysisMaterial = value
7673
7674	@AnalysisValue.setter
7675	def AnalysisValue(self, value: float) -> None:
7676		self._Entity.AnalysisValue = value
7677
7678	@overload
7679	def AddMaterials(self, materialIds: set[int]) -> None: ...
7680
7681	@overload
7682	def AddMaterials(self, materialNames: set[str]) -> None: ...
7683
7684	def GetSizingMaterials(self) -> list[int]:
7685		'''
7686		Get a list of materials used for sizing, if they exist.
7687		'''
7688		return [int32 for int32 in self._Entity.GetSizingMaterials()]
7689
7690	def RemoveSizingMaterials(self, materialIds: tuple[int] = None) -> None:
7691		materialIdsList = MakeCSharpIntList(materialIds)
7692		materialIdsEnumerable = IEnumerable(materialIdsList)
7693		return self._Entity.RemoveSizingMaterials(materialIds if materialIds is None else materialIdsEnumerable)
7694
7695	def GetAnalysisMaterial(self) -> int:
7696		'''
7697		Get the material used for analysis, if it exists.
7698		'''
7699		return self._Entity.GetAnalysisMaterial()
7700
7701	def RemoveAnalysisMaterial(self) -> None:
7702		'''
7703		Remove the analysis material assigned to this variable.
7704		'''
7705		return self._Entity.RemoveAnalysisMaterial()
7706
7707	def AddMaterials(self, item1 = None) -> None:
7708		if isinstance(item1, set) and item1 and isinstance(list(item1)[0], int):
7709			materialIdsSet = HashSet[int]()
7710			if item1 is not None:
7711				for thing in item1:
7712					if thing is not None:
7713						materialIdsSet.Add(thing)
7714			return self._Entity.AddMaterials(materialIdsSet)
7715
7716		if isinstance(item1, set) and item1 and isinstance(list(item1)[0], str):
7717			materialNamesSet = HashSet[str]()
7718			if item1 is not None:
7719				for thing in item1:
7720					if thing is not None:
7721						materialNamesSet.Add(thing)
7722			return self._Entity.AddMaterials(materialNamesSet)
7723
7724		return self._Entity.AddMaterials(item1)
7725
7726
7727class ToolingConstraintCol(IdNameEntityCol[ToolingConstraint]):
7728	def __init__(self, toolingConstraintCol: _api.ToolingConstraintCol):
7729		self._Entity = toolingConstraintCol
7730		self._CollectedClass = ToolingConstraint
7731
7732	@property
7733	def ToolingConstraintColList(self) -> tuple[ToolingConstraint]:
7734		return tuple([ToolingConstraint(toolingConstraintCol) for toolingConstraintCol in self._Entity])
7735
7736	@overload
7737	def Get(self, name: str) -> ToolingConstraint: ...
7738
7739	@overload
7740	def Get(self, id: int) -> ToolingConstraint: ...
7741
7742	def Get(self, item1 = None) -> ToolingConstraint:
7743		if isinstance(item1, str):
7744			return ToolingConstraint(super().Get(item1))
7745
7746		if isinstance(item1, int):
7747			return ToolingConstraint(super().Get(item1))
7748
7749		return ToolingConstraint(self._Entity.Get(item1))
7750
7751	def __getitem__(self, index: int):
7752		return self.ToolingConstraintColList[index]
7753
7754	def __iter__(self):
7755		yield from self.ToolingConstraintColList
7756
7757	def __len__(self):
7758		return len(self.ToolingConstraintColList)
7759
7760
7761class DesignVariableCol(IdEntityCol[DesignVariable]):
7762	def __init__(self, designVariableCol: _api.DesignVariableCol):
7763		self._Entity = designVariableCol
7764		self._CollectedClass = DesignVariable
7765
7766	@property
7767	def DesignVariableColList(self) -> tuple[DesignVariable]:
7768		return tuple([DesignVariable(designVariableCol) for designVariableCol in self._Entity])
7769
7770	@overload
7771	def Get(self, parameterId: types.VariableParameter) -> DesignVariable: ...
7772
7773	@overload
7774	def Get(self, id: int) -> DesignVariable: ...
7775
7776	def Get(self, item1 = None) -> DesignVariable:
7777		if isinstance(item1, types.VariableParameter):
7778			return DesignVariable(self._Entity.Get(_types.VariableParameter(item1.value)))
7779
7780		if isinstance(item1, int):
7781			return DesignVariable(super().Get(item1))
7782
7783		return DesignVariable(self._Entity.Get(_types.VariableParameter(item1.value)))
7784
7785	def __getitem__(self, index: int):
7786		return self.DesignVariableColList[index]
7787
7788	def __iter__(self):
7789		yield from self.DesignVariableColList
7790
7791	def __len__(self):
7792		return len(self.DesignVariableColList)
7793
7794
7795class ZoneDesignProperty(DesignProperty):
7796	def __init__(self, zoneDesignProperty: _api.ZoneDesignProperty):
7797		self._Entity = zoneDesignProperty
7798
7799	@property
7800	def FamilyId(self) -> types.BeamPanelFamily:
7801		return types.BeamPanelFamily[self._Entity.FamilyId.ToString()]
7802
7803	@property
7804	def ConceptId(self) -> int:
7805		return self._Entity.ConceptId
7806
7807	@property
7808	def FamilyConceptUID(self) -> types.FamilyConceptUID:
7809		return types.FamilyConceptUID[self._Entity.FamilyConceptUID.ToString()]
7810
7811	@property
7812	def ToolingConstraints(self) -> ToolingConstraintCol:
7813		result = self._Entity.ToolingConstraints
7814		return ToolingConstraintCol(result) if result is not None else None
7815
7816	@property
7817	def DesignVariables(self) -> DesignVariableCol:
7818		result = self._Entity.DesignVariables
7819		return DesignVariableCol(result) if result is not None else None
7820
7821
7822class BulkUpdaterBase(ABC):
7823	def __init__(self, bulkUpdaterBase: _api.BulkUpdaterBase):
7824		self._Entity = bulkUpdaterBase
7825
7826	def Update(self, func: Action) -> None:
7827		entityType = self._Entity.GetType().BaseType.GenericTypeArguments[0]
7828		funcAction = Action[entityType](func)
7829		return self._Entity.Update(funcAction)
7830
7831
7832class LoadPropertyUserRowBulkUpdater(BulkUpdaterBase):
7833	def __init__(self, loadPropertyUserRowBulkUpdater: _api.LoadPropertyUserRowBulkUpdater):
7834		self._Entity = loadPropertyUserRowBulkUpdater
7835
7836
7837class LoadPropertyUserRow(IdNameEntity):
7838	def __init__(self, loadPropertyUserRow: _api.LoadPropertyUserRow):
7839		self._Entity = loadPropertyUserRow
7840
7841	@property
7842	def LoadScenarioId(self) -> int:
7843		return self._Entity.LoadScenarioId
7844
7845	@property
7846	def LoadPropertyId(self) -> int:
7847		return self._Entity.LoadPropertyId
7848
7849	@property
7850	def Type(self) -> types.LoadSetType:
7851		return types.LoadSetType[self._Entity.Type.ToString()]
7852
7853	@property
7854	def ReferenceTemperature(self) -> float:
7855		return self._Entity.ReferenceTemperature
7856
7857	@property
7858	def PressureOrTemperature(self) -> float:
7859		return self._Entity.PressureOrTemperature
7860
7861	@property
7862	def LimitFactor(self) -> float:
7863		return self._Entity.LimitFactor
7864
7865	@property
7866	def UltimateFactor(self) -> float:
7867		return self._Entity.UltimateFactor
7868
7869	@ReferenceTemperature.setter
7870	def ReferenceTemperature(self, value: float) -> None:
7871		self._Entity.ReferenceTemperature = value
7872
7873	@PressureOrTemperature.setter
7874	def PressureOrTemperature(self, value: float) -> None:
7875		self._Entity.PressureOrTemperature = value
7876
7877	@LimitFactor.setter
7878	def LimitFactor(self, value: float) -> None:
7879		self._Entity.LimitFactor = value
7880
7881	@UltimateFactor.setter
7882	def UltimateFactor(self, value: float) -> None:
7883		self._Entity.UltimateFactor = value
7884
7885
7886class LoadPropertyUserBeamRow(LoadPropertyUserRow):
7887	def __init__(self, loadPropertyUserBeamRow: _api.LoadPropertyUserBeamRow):
7888		self._Entity = loadPropertyUserBeamRow
7889
7890	@property
7891	def M1A(self) -> float:
7892		return self._Entity.M1A
7893
7894	@property
7895	def M2A(self) -> float:
7896		return self._Entity.M2A
7897
7898	@property
7899	def M1B(self) -> float:
7900		return self._Entity.M1B
7901
7902	@property
7903	def M2B(self) -> float:
7904		return self._Entity.M2B
7905
7906	@property
7907	def V1(self) -> float:
7908		return self._Entity.V1
7909
7910	@property
7911	def V2(self) -> float:
7912		return self._Entity.V2
7913
7914	@property
7915	def Axial(self) -> float:
7916		return self._Entity.Axial
7917
7918	@property
7919	def Torque(self) -> float:
7920		return self._Entity.Torque
7921
7922	@M1A.setter
7923	def M1A(self, value: float) -> None:
7924		self._Entity.M1A = value
7925
7926	@M2A.setter
7927	def M2A(self, value: float) -> None:
7928		self._Entity.M2A = value
7929
7930	@M1B.setter
7931	def M1B(self, value: float) -> None:
7932		self._Entity.M1B = value
7933
7934	@M2B.setter
7935	def M2B(self, value: float) -> None:
7936		self._Entity.M2B = value
7937
7938	@V1.setter
7939	def V1(self, value: float) -> None:
7940		self._Entity.V1 = value
7941
7942	@V2.setter
7943	def V2(self, value: float) -> None:
7944		self._Entity.V2 = value
7945
7946	@Axial.setter
7947	def Axial(self, value: float) -> None:
7948		self._Entity.Axial = value
7949
7950	@Torque.setter
7951	def Torque(self, value: float) -> None:
7952		self._Entity.Torque = value
7953
7954
7955class LoadPropertyUserFeaBeamRow(LoadPropertyUserBeamRow):
7956	def __init__(self, loadPropertyUserFeaBeamRow: _api.LoadPropertyUserFeaBeamRow):
7957		self._Entity = loadPropertyUserFeaBeamRow
7958
7959	def SetName(self, name: str) -> None:
7960		return self._Entity.SetName(name)
7961
7962
7963class LoadPropertyUserFeaBeamRowBulkUpdater(LoadPropertyUserRowBulkUpdater):
7964	def __init__(self, loadPropertyUserFeaBeamRowBulkUpdater: _api.LoadPropertyUserFeaBeamRowBulkUpdater):
7965		self._Entity = loadPropertyUserFeaBeamRowBulkUpdater
7966
7967	def GetBulkUpdater(application: Application, items: list[LoadPropertyUserFeaBeamRow]) -> LoadPropertyUserFeaBeamRowBulkUpdater:
7968		itemsList = List[_api.LoadPropertyUserFeaBeamRow]()
7969		if items is not None:
7970			for thing in items:
7971				if thing is not None:
7972					itemsList.Add(thing._Entity)
7973		return LoadPropertyUserFeaBeamRowBulkUpdater(_api.LoadPropertyUserFeaBeamRowBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
7974
7975
7976class LoadPropertyUserPanelJointRow(LoadPropertyUserRow):
7977	def __init__(self, loadPropertyUserPanelJointRow: _api.LoadPropertyUserPanelJointRow):
7978		self._Entity = loadPropertyUserPanelJointRow
7979
7980	@property
7981	def Nx(self) -> float:
7982		return self._Entity.Nx
7983
7984	@property
7985	def Ny(self) -> float:
7986		return self._Entity.Ny
7987
7988	@property
7989	def Nxy(self) -> float:
7990		return self._Entity.Nxy
7991
7992	@property
7993	def Mx(self) -> float:
7994		return self._Entity.Mx
7995
7996	@property
7997	def My(self) -> float:
7998		return self._Entity.My
7999
8000	@property
8001	def Mxy(self) -> float:
8002		return self._Entity.Mxy
8003
8004	@property
8005	def Qx(self) -> float:
8006		return self._Entity.Qx
8007
8008	@property
8009	def Qy(self) -> float:
8010		return self._Entity.Qy
8011
8012	@Nx.setter
8013	def Nx(self, value: float) -> None:
8014		self._Entity.Nx = value
8015
8016	@Ny.setter
8017	def Ny(self, value: float) -> None:
8018		self._Entity.Ny = value
8019
8020	@Nxy.setter
8021	def Nxy(self, value: float) -> None:
8022		self._Entity.Nxy = value
8023
8024	@Mx.setter
8025	def Mx(self, value: float) -> None:
8026		self._Entity.Mx = value
8027
8028	@My.setter
8029	def My(self, value: float) -> None:
8030		self._Entity.My = value
8031
8032	@Mxy.setter
8033	def Mxy(self, value: float) -> None:
8034		self._Entity.Mxy = value
8035
8036	@Qx.setter
8037	def Qx(self, value: float) -> None:
8038		self._Entity.Qx = value
8039
8040	@Qy.setter
8041	def Qy(self, value: float) -> None:
8042		self._Entity.Qy = value
8043
8044
8045class LoadPropertyUserFeaJointRow(LoadPropertyUserPanelJointRow):
8046	def __init__(self, loadPropertyUserFeaJointRow: _api.LoadPropertyUserFeaJointRow):
8047		self._Entity = loadPropertyUserFeaJointRow
8048
8049	def SetName(self, name: str) -> None:
8050		return self._Entity.SetName(name)
8051
8052
8053class LoadPropertyUserFeaJointRowBulkUpdater(LoadPropertyUserRowBulkUpdater):
8054	def __init__(self, loadPropertyUserFeaJointRowBulkUpdater: _api.LoadPropertyUserFeaJointRowBulkUpdater):
8055		self._Entity = loadPropertyUserFeaJointRowBulkUpdater
8056
8057	def GetBulkUpdater(application: Application, items: list[LoadPropertyUserFeaJointRow]) -> LoadPropertyUserFeaJointRowBulkUpdater:
8058		itemsList = List[_api.LoadPropertyUserFeaJointRow]()
8059		if items is not None:
8060			for thing in items:
8061				if thing is not None:
8062					itemsList.Add(thing._Entity)
8063		return LoadPropertyUserFeaJointRowBulkUpdater(_api.LoadPropertyUserFeaJointRowBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
8064
8065
8066class LoadPropertyUserFeaPanelRow(LoadPropertyUserPanelJointRow):
8067	def __init__(self, loadPropertyUserFeaPanelRow: _api.LoadPropertyUserFeaPanelRow):
8068		self._Entity = loadPropertyUserFeaPanelRow
8069
8070	def SetName(self, name: str) -> None:
8071		return self._Entity.SetName(name)
8072
8073
8074class LoadPropertyUserFeaPanelRowBulkUpdater(LoadPropertyUserRowBulkUpdater):
8075	def __init__(self, loadPropertyUserFeaPanelRowBulkUpdater: _api.LoadPropertyUserFeaPanelRowBulkUpdater):
8076		self._Entity = loadPropertyUserFeaPanelRowBulkUpdater
8077
8078	def GetBulkUpdater(application: Application, items: list[LoadPropertyUserFeaPanelRow]) -> LoadPropertyUserFeaPanelRowBulkUpdater:
8079		itemsList = List[_api.LoadPropertyUserFeaPanelRow]()
8080		if items is not None:
8081			for thing in items:
8082				if thing is not None:
8083					itemsList.Add(thing._Entity)
8084		return LoadPropertyUserFeaPanelRowBulkUpdater(_api.LoadPropertyUserFeaPanelRowBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
8085
8086
8087class LoadPropertyUserGeneralBeamRow(LoadPropertyUserBeamRow):
8088	def __init__(self, loadPropertyUserGeneralBeamRow: _api.LoadPropertyUserGeneralBeamRow):
8089		self._Entity = loadPropertyUserGeneralBeamRow
8090
8091	@property
8092	def M1A(self) -> float:
8093		return self._Entity.M1A
8094
8095	@property
8096	def M2A(self) -> float:
8097		return self._Entity.M2A
8098
8099	@property
8100	def M1B(self) -> float:
8101		return self._Entity.M1B
8102
8103	@property
8104	def M2B(self) -> float:
8105		return self._Entity.M2B
8106
8107	@property
8108	def V1(self) -> float:
8109		return self._Entity.V1
8110
8111	@property
8112	def V2(self) -> float:
8113		return self._Entity.V2
8114
8115	@property
8116	def Axial(self) -> float:
8117		return self._Entity.Axial
8118
8119	@property
8120	def Torque(self) -> float:
8121		return self._Entity.Torque
8122
8123	@property
8124	def M1AType(self) -> types.BoundaryConditionType:
8125		return types.BoundaryConditionType[self._Entity.M1AType.ToString()]
8126
8127	@property
8128	def M2AType(self) -> types.BoundaryConditionType:
8129		return types.BoundaryConditionType[self._Entity.M2AType.ToString()]
8130
8131	@property
8132	def M1BType(self) -> types.BoundaryConditionType:
8133		return types.BoundaryConditionType[self._Entity.M1BType.ToString()]
8134
8135	@property
8136	def M2BType(self) -> types.BoundaryConditionType:
8137		return types.BoundaryConditionType[self._Entity.M2BType.ToString()]
8138
8139	@property
8140	def V1Type(self) -> types.BoundaryConditionType:
8141		return types.BoundaryConditionType[self._Entity.V1Type.ToString()]
8142
8143	@property
8144	def V2Type(self) -> types.BoundaryConditionType:
8145		return types.BoundaryConditionType[self._Entity.V2Type.ToString()]
8146
8147	@property
8148	def AxialType(self) -> types.BoundaryConditionType:
8149		return types.BoundaryConditionType[self._Entity.AxialType.ToString()]
8150
8151	@property
8152	def TorqueType(self) -> types.BoundaryConditionType:
8153		return types.BoundaryConditionType[self._Entity.TorqueType.ToString()]
8154
8155	@M1A.setter
8156	def M1A(self, value: float) -> None:
8157		self._Entity.M1A = value
8158
8159	@M2A.setter
8160	def M2A(self, value: float) -> None:
8161		self._Entity.M2A = value
8162
8163	@M1B.setter
8164	def M1B(self, value: float) -> None:
8165		self._Entity.M1B = value
8166
8167	@M2B.setter
8168	def M2B(self, value: float) -> None:
8169		self._Entity.M2B = value
8170
8171	@V1.setter
8172	def V1(self, value: float) -> None:
8173		self._Entity.V1 = value
8174
8175	@V2.setter
8176	def V2(self, value: float) -> None:
8177		self._Entity.V2 = value
8178
8179	@Axial.setter
8180	def Axial(self, value: float) -> None:
8181		self._Entity.Axial = value
8182
8183	@Torque.setter
8184	def Torque(self, value: float) -> None:
8185		self._Entity.Torque = value
8186
8187
8188class LoadPropertyUserGeneralBeamRowBulkUpdater(LoadPropertyUserRowBulkUpdater):
8189	def __init__(self, loadPropertyUserGeneralBeamRowBulkUpdater: _api.LoadPropertyUserGeneralBeamRowBulkUpdater):
8190		self._Entity = loadPropertyUserGeneralBeamRowBulkUpdater
8191
8192	def GetBulkUpdater(application: Application, items: list[LoadPropertyUserGeneralBeamRow]) -> LoadPropertyUserGeneralBeamRowBulkUpdater:
8193		itemsList = List[_api.LoadPropertyUserGeneralBeamRow]()
8194		if items is not None:
8195			for thing in items:
8196				if thing is not None:
8197					itemsList.Add(thing._Entity)
8198		return LoadPropertyUserGeneralBeamRowBulkUpdater(_api.LoadPropertyUserGeneralBeamRowBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
8199
8200
8201class LoadPropertyUserGeneralPanelRow(LoadPropertyUserPanelJointRow):
8202	def __init__(self, loadPropertyUserGeneralPanelRow: _api.LoadPropertyUserGeneralPanelRow):
8203		self._Entity = loadPropertyUserGeneralPanelRow
8204
8205	@property
8206	def Nx(self) -> float:
8207		return self._Entity.Nx
8208
8209	@property
8210	def Ny(self) -> float:
8211		return self._Entity.Ny
8212
8213	@property
8214	def Nxy(self) -> float:
8215		return self._Entity.Nxy
8216
8217	@property
8218	def Mx(self) -> float:
8219		return self._Entity.Mx
8220
8221	@property
8222	def My(self) -> float:
8223		return self._Entity.My
8224
8225	@property
8226	def Mxy(self) -> float:
8227		return self._Entity.Mxy
8228
8229	@property
8230	def Qx(self) -> float:
8231		return self._Entity.Qx
8232
8233	@property
8234	def Qy(self) -> float:
8235		return self._Entity.Qy
8236
8237	@property
8238	def NxType(self) -> types.BoundaryConditionType:
8239		return types.BoundaryConditionType[self._Entity.NxType.ToString()]
8240
8241	@property
8242	def NyType(self) -> types.BoundaryConditionType:
8243		return types.BoundaryConditionType[self._Entity.NyType.ToString()]
8244
8245	@property
8246	def NxyType(self) -> types.BoundaryConditionType:
8247		return types.BoundaryConditionType[self._Entity.NxyType.ToString()]
8248
8249	@property
8250	def MxType(self) -> types.BoundaryConditionType:
8251		return types.BoundaryConditionType[self._Entity.MxType.ToString()]
8252
8253	@property
8254	def MyType(self) -> types.BoundaryConditionType:
8255		return types.BoundaryConditionType[self._Entity.MyType.ToString()]
8256
8257	@property
8258	def MxyType(self) -> types.BoundaryConditionType:
8259		return types.BoundaryConditionType[self._Entity.MxyType.ToString()]
8260
8261	@property
8262	def QxType(self) -> types.BoundaryConditionType:
8263		return types.BoundaryConditionType[self._Entity.QxType.ToString()]
8264
8265	@property
8266	def QyType(self) -> types.BoundaryConditionType:
8267		return types.BoundaryConditionType[self._Entity.QyType.ToString()]
8268
8269	@Nx.setter
8270	def Nx(self, value: float) -> None:
8271		self._Entity.Nx = value
8272
8273	@Ny.setter
8274	def Ny(self, value: float) -> None:
8275		self._Entity.Ny = value
8276
8277	@Nxy.setter
8278	def Nxy(self, value: float) -> None:
8279		self._Entity.Nxy = value
8280
8281	@Mx.setter
8282	def Mx(self, value: float) -> None:
8283		self._Entity.Mx = value
8284
8285	@My.setter
8286	def My(self, value: float) -> None:
8287		self._Entity.My = value
8288
8289	@Mxy.setter
8290	def Mxy(self, value: float) -> None:
8291		self._Entity.Mxy = value
8292
8293	@Qx.setter
8294	def Qx(self, value: float) -> None:
8295		self._Entity.Qx = value
8296
8297	@Qy.setter
8298	def Qy(self, value: float) -> None:
8299		self._Entity.Qy = value
8300
8301
8302class LoadPropertyUserGeneralPanelRowBulkUpdater(LoadPropertyUserRowBulkUpdater):
8303	def __init__(self, loadPropertyUserGeneralPanelRowBulkUpdater: _api.LoadPropertyUserGeneralPanelRowBulkUpdater):
8304		self._Entity = loadPropertyUserGeneralPanelRowBulkUpdater
8305
8306	def GetBulkUpdater(application: Application, items: list[LoadPropertyUserGeneralPanelRow]) -> LoadPropertyUserGeneralPanelRowBulkUpdater:
8307		itemsList = List[_api.LoadPropertyUserGeneralPanelRow]()
8308		if items is not None:
8309			for thing in items:
8310				if thing is not None:
8311					itemsList.Add(thing._Entity)
8312		return LoadPropertyUserGeneralPanelRowBulkUpdater(_api.LoadPropertyUserGeneralPanelRowBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
8313
8314
8315class LoadPropertyFea(LoadProperty):
8316	def __init__(self, loadPropertyFea: _api.LoadPropertyFea):
8317		self._Entity = loadPropertyFea
8318
8319	@property
8320	def HasNx(self) -> bool:
8321		return self._Entity.HasNx
8322
8323	@property
8324	def HasNy(self) -> bool:
8325		return self._Entity.HasNy
8326
8327	@property
8328	def HasNxy(self) -> bool:
8329		return self._Entity.HasNxy
8330
8331	@property
8332	def HasMx(self) -> bool:
8333		return self._Entity.HasMx
8334
8335	@property
8336	def HasMy(self) -> bool:
8337		return self._Entity.HasMy
8338
8339	@property
8340	def HasMxy(self) -> bool:
8341		return self._Entity.HasMxy
8342
8343	@property
8344	def HasQx(self) -> bool:
8345		return self._Entity.HasQx
8346
8347	@property
8348	def HasQy(self) -> bool:
8349		return self._Entity.HasQy
8350
8351	@property
8352	def HasM1a(self) -> bool:
8353		return self._Entity.HasM1a
8354
8355	@property
8356	def HasM1b(self) -> bool:
8357		return self._Entity.HasM1b
8358
8359	@property
8360	def M2a(self) -> bool:
8361		return self._Entity.M2a
8362
8363	@property
8364	def V1(self) -> bool:
8365		return self._Entity.V1
8366
8367	@property
8368	def V2(self) -> bool:
8369		return self._Entity.V2
8370
8371	@property
8372	def Axial(self) -> bool:
8373		return self._Entity.Axial
8374
8375	@property
8376	def Torque(self) -> bool:
8377		return self._Entity.Torque
8378
8379	@property
8380	def Tension(self) -> bool:
8381		return self._Entity.Tension
8382
8383	@property
8384	def Shear(self) -> bool:
8385		return self._Entity.Shear
8386
8387	@property
8388	def Moment(self) -> bool:
8389		return self._Entity.Moment
8390
8391	@HasNx.setter
8392	def HasNx(self, value: bool) -> None:
8393		self._Entity.HasNx = value
8394
8395	@HasNy.setter
8396	def HasNy(self, value: bool) -> None:
8397		self._Entity.HasNy = value
8398
8399	@HasNxy.setter
8400	def HasNxy(self, value: bool) -> None:
8401		self._Entity.HasNxy = value
8402
8403	@HasMx.setter
8404	def HasMx(self, value: bool) -> None:
8405		self._Entity.HasMx = value
8406
8407	@HasMy.setter
8408	def HasMy(self, value: bool) -> None:
8409		self._Entity.HasMy = value
8410
8411	@HasMxy.setter
8412	def HasMxy(self, value: bool) -> None:
8413		self._Entity.HasMxy = value
8414
8415	@HasQx.setter
8416	def HasQx(self, value: bool) -> None:
8417		self._Entity.HasQx = value
8418
8419	@HasQy.setter
8420	def HasQy(self, value: bool) -> None:
8421		self._Entity.HasQy = value
8422
8423	@HasM1a.setter
8424	def HasM1a(self, value: bool) -> None:
8425		self._Entity.HasM1a = value
8426
8427	@HasM1b.setter
8428	def HasM1b(self, value: bool) -> None:
8429		self._Entity.HasM1b = value
8430
8431	@M2a.setter
8432	def M2a(self, value: bool) -> None:
8433		self._Entity.M2a = value
8434
8435	@V1.setter
8436	def V1(self, value: bool) -> None:
8437		self._Entity.V1 = value
8438
8439	@V2.setter
8440	def V2(self, value: bool) -> None:
8441		self._Entity.V2 = value
8442
8443	@Axial.setter
8444	def Axial(self, value: bool) -> None:
8445		self._Entity.Axial = value
8446
8447	@Torque.setter
8448	def Torque(self, value: bool) -> None:
8449		self._Entity.Torque = value
8450
8451	@Tension.setter
8452	def Tension(self, value: bool) -> None:
8453		self._Entity.Tension = value
8454
8455	@Shear.setter
8456	def Shear(self, value: bool) -> None:
8457		self._Entity.Shear = value
8458
8459	@Moment.setter
8460	def Moment(self, value: bool) -> None:
8461		self._Entity.Moment = value
8462
8463
8464class LoadPropertyAverage(LoadPropertyFea):
8465	def __init__(self, loadPropertyAverage: _api.LoadPropertyAverage):
8466		self._Entity = loadPropertyAverage
8467
8468	@property
8469	def ElementType(self) -> types.LoadPropertyAverageElementType:
8470		return types.LoadPropertyAverageElementType[self._Entity.ElementType.ToString()]
8471
8472	@ElementType.setter
8473	def ElementType(self, value: types.LoadPropertyAverageElementType) -> None:
8474		self._Entity.ElementType = _types.LoadPropertyAverageElementType(value.value)
8475
8476
8477class LoadPropertyElementBased(LoadPropertyFea):
8478	def __init__(self, loadPropertyElementBased: _api.LoadPropertyElementBased):
8479		self._Entity = loadPropertyElementBased
8480
8481
8482class LoadPropertyNeighborAverage(LoadPropertyFea):
8483	def __init__(self, loadPropertyNeighborAverage: _api.LoadPropertyNeighborAverage):
8484		self._Entity = loadPropertyNeighborAverage
8485
8486	@property
8487	def NumberOfNeighborsPerSide(self) -> int:
8488		return self._Entity.NumberOfNeighborsPerSide
8489
8490	@NumberOfNeighborsPerSide.setter
8491	def NumberOfNeighborsPerSide(self, value: int) -> None:
8492		self._Entity.NumberOfNeighborsPerSide = value
8493
8494
8495class LoadPropertyPeakLoad(LoadPropertyFea):
8496	def __init__(self, loadPropertyPeakLoad: _api.LoadPropertyPeakLoad):
8497		self._Entity = loadPropertyPeakLoad
8498
8499	@property
8500	def ElementScope(self) -> types.LoadPropertyPeakElementScope:
8501		return types.LoadPropertyPeakElementScope[self._Entity.ElementScope.ToString()]
8502
8503	@ElementScope.setter
8504	def ElementScope(self, value: types.LoadPropertyPeakElementScope) -> None:
8505		self._Entity.ElementScope = _types.LoadPropertyPeakElementScope(value.value)
8506
8507
8508class LoadPropertyStatistical(LoadPropertyFea):
8509	def __init__(self, loadPropertyStatistical: _api.LoadPropertyStatistical):
8510		self._Entity = loadPropertyStatistical
8511
8512	@property
8513	def NSigma(self) -> int:
8514		return self._Entity.NSigma
8515
8516	@NSigma.setter
8517	def NSigma(self, value: int) -> None:
8518		self._Entity.NSigma = value
8519
8520
8521class LoadPropertyUserFeaRowCol(IdNameEntityCol, Generic[T]):
8522	def __init__(self, loadPropertyUserFeaRowCol: _api.LoadPropertyUserFeaRowCol):
8523		self._Entity = loadPropertyUserFeaRowCol
8524		self._CollectedClass = T
8525
8526	@property
8527	def LoadPropertyUserFeaRowColList(self) -> tuple[T]:
8528		if self._Entity.Count() <= 0:
8529			return ()
8530		thisClass = type(self._Entity._items[0]).__name__
8531		givenClass = T
8532		for subclass in T.__subclasses__():
8533			if subclass.__name__ == thisClass:
8534				givenClass = subclass
8535		return tuple([givenClass(loadPropertyUserFeaRowCol) for loadPropertyUserFeaRowCol in self._Entity])
8536
8537	def AddScenario(self, name: str = None) -> T:
8538		return self._Entity.AddScenario(name)
8539
8540	@overload
8541	def DeleteScenario(self, scenarioId: int) -> bool: ...
8542
8543	@overload
8544	def DeleteScenario(self, scenarioName: str) -> bool: ...
8545
8546	@overload
8547	def Get(self, name: str) -> T: ...
8548
8549	@overload
8550	def Get(self, id: int) -> T: ...
8551
8552	def DeleteScenario(self, item1 = None) -> bool:
8553		if isinstance(item1, int):
8554			return self._Entity.DeleteScenario(item1)
8555
8556		if isinstance(item1, str):
8557			return self._Entity.DeleteScenario(item1)
8558
8559		return self._Entity.DeleteScenario(item1)
8560
8561	def Get(self, item1 = None) -> T:
8562		if isinstance(item1, str):
8563			return super().Get(item1)
8564
8565		if isinstance(item1, int):
8566			return super().Get(item1)
8567
8568		return self._Entity.Get(item1)
8569
8570	def __getitem__(self, index: int):
8571		return self.LoadPropertyUserFeaRowColList[index]
8572
8573	def __iter__(self):
8574		yield from self.LoadPropertyUserFeaRowColList
8575
8576	def __len__(self):
8577		return len(self.LoadPropertyUserFeaRowColList)
8578
8579
8580class LoadPropertyUserFeaBeamRowCol(LoadPropertyUserFeaRowCol[LoadPropertyUserFeaBeamRow]):
8581	def __init__(self, loadPropertyUserFeaBeamRowCol: _api.LoadPropertyUserFeaBeamRowCol):
8582		self._Entity = loadPropertyUserFeaBeamRowCol
8583		self._CollectedClass = LoadPropertyUserFeaBeamRow
8584
8585	@property
8586	def LoadPropertyUserFeaBeamRowColList(self) -> tuple[LoadPropertyUserFeaBeamRow]:
8587		return tuple([LoadPropertyUserFeaBeamRow(loadPropertyUserFeaBeamRowCol) for loadPropertyUserFeaBeamRowCol in self._Entity])
8588
8589	@overload
8590	def DeleteScenario(self, scenarioId: int) -> bool: ...
8591
8592	@overload
8593	def DeleteScenario(self, scenarioName: str) -> bool: ...
8594
8595	@overload
8596	def Get(self, name: str) -> LoadPropertyUserFeaBeamRow: ...
8597
8598	@overload
8599	def Get(self, id: int) -> LoadPropertyUserFeaBeamRow: ...
8600
8601	def DeleteScenario(self, item1 = None) -> bool:
8602		if isinstance(item1, int):
8603			return bool(super().DeleteScenario(item1))
8604
8605		if isinstance(item1, str):
8606			return bool(super().DeleteScenario(item1))
8607
8608		return self._Entity.DeleteScenario(item1)
8609
8610	def Get(self, item1 = None) -> LoadPropertyUserFeaBeamRow:
8611		if isinstance(item1, str):
8612			return LoadPropertyUserFeaBeamRow(super().Get(item1))
8613
8614		if isinstance(item1, int):
8615			return LoadPropertyUserFeaBeamRow(super().Get(item1))
8616
8617		return LoadPropertyUserFeaBeamRow(self._Entity.Get(item1))
8618
8619	def __getitem__(self, index: int):
8620		return self.LoadPropertyUserFeaBeamRowColList[index]
8621
8622	def __iter__(self):
8623		yield from self.LoadPropertyUserFeaBeamRowColList
8624
8625	def __len__(self):
8626		return len(self.LoadPropertyUserFeaBeamRowColList)
8627
8628
8629class LoadPropertyUserFeaBeam(LoadProperty):
8630	def __init__(self, loadPropertyUserFeaBeam: _api.LoadPropertyUserFeaBeam):
8631		self._Entity = loadPropertyUserFeaBeam
8632
8633	@property
8634	def UserFeaRows(self) -> LoadPropertyUserFeaBeamRowCol:
8635		result = self._Entity.UserFeaRows
8636		return LoadPropertyUserFeaBeamRowCol(result) if result is not None else None
8637
8638
8639class LoadPropertyUserFeaJointRowCol(LoadPropertyUserFeaRowCol[LoadPropertyUserFeaJointRow]):
8640	def __init__(self, loadPropertyUserFeaJointRowCol: _api.LoadPropertyUserFeaJointRowCol):
8641		self._Entity = loadPropertyUserFeaJointRowCol
8642		self._CollectedClass = LoadPropertyUserFeaJointRow
8643
8644	@property
8645	def LoadPropertyUserFeaJointRowColList(self) -> tuple[LoadPropertyUserFeaJointRow]:
8646		return tuple([LoadPropertyUserFeaJointRow(loadPropertyUserFeaJointRowCol) for loadPropertyUserFeaJointRowCol in self._Entity])
8647
8648	@overload
8649	def DeleteScenario(self, scenarioId: int) -> bool: ...
8650
8651	@overload
8652	def DeleteScenario(self, scenarioName: str) -> bool: ...
8653
8654	@overload
8655	def Get(self, name: str) -> LoadPropertyUserFeaJointRow: ...
8656
8657	@overload
8658	def Get(self, id: int) -> LoadPropertyUserFeaJointRow: ...
8659
8660	def DeleteScenario(self, item1 = None) -> bool:
8661		if isinstance(item1, int):
8662			return bool(super().DeleteScenario(item1))
8663
8664		if isinstance(item1, str):
8665			return bool(super().DeleteScenario(item1))
8666
8667		return self._Entity.DeleteScenario(item1)
8668
8669	def Get(self, item1 = None) -> LoadPropertyUserFeaJointRow:
8670		if isinstance(item1, str):
8671			return LoadPropertyUserFeaJointRow(super().Get(item1))
8672
8673		if isinstance(item1, int):
8674			return LoadPropertyUserFeaJointRow(super().Get(item1))
8675
8676		return LoadPropertyUserFeaJointRow(self._Entity.Get(item1))
8677
8678	def __getitem__(self, index: int):
8679		return self.LoadPropertyUserFeaJointRowColList[index]
8680
8681	def __iter__(self):
8682		yield from self.LoadPropertyUserFeaJointRowColList
8683
8684	def __len__(self):
8685		return len(self.LoadPropertyUserFeaJointRowColList)
8686
8687
8688class LoadPropertyUserFeaJoint(LoadProperty):
8689	def __init__(self, loadPropertyUserFeaJoint: _api.LoadPropertyUserFeaJoint):
8690		self._Entity = loadPropertyUserFeaJoint
8691
8692	@property
8693	def UserFeaRows(self) -> LoadPropertyUserFeaJointRowCol:
8694		result = self._Entity.UserFeaRows
8695		return LoadPropertyUserFeaJointRowCol(result) if result is not None else None
8696
8697
8698class LoadPropertyUserFeaPanelRowCol(LoadPropertyUserFeaRowCol[LoadPropertyUserFeaPanelRow]):
8699	def __init__(self, loadPropertyUserFeaPanelRowCol: _api.LoadPropertyUserFeaPanelRowCol):
8700		self._Entity = loadPropertyUserFeaPanelRowCol
8701		self._CollectedClass = LoadPropertyUserFeaPanelRow
8702
8703	@property
8704	def LoadPropertyUserFeaPanelRowColList(self) -> tuple[LoadPropertyUserFeaPanelRow]:
8705		return tuple([LoadPropertyUserFeaPanelRow(loadPropertyUserFeaPanelRowCol) for loadPropertyUserFeaPanelRowCol in self._Entity])
8706
8707	@overload
8708	def DeleteScenario(self, scenarioId: int) -> bool: ...
8709
8710	@overload
8711	def DeleteScenario(self, scenarioName: str) -> bool: ...
8712
8713	@overload
8714	def Get(self, name: str) -> LoadPropertyUserFeaPanelRow: ...
8715
8716	@overload
8717	def Get(self, id: int) -> LoadPropertyUserFeaPanelRow: ...
8718
8719	def DeleteScenario(self, item1 = None) -> bool:
8720		if isinstance(item1, int):
8721			return bool(super().DeleteScenario(item1))
8722
8723		if isinstance(item1, str):
8724			return bool(super().DeleteScenario(item1))
8725
8726		return self._Entity.DeleteScenario(item1)
8727
8728	def Get(self, item1 = None) -> LoadPropertyUserFeaPanelRow:
8729		if isinstance(item1, str):
8730			return LoadPropertyUserFeaPanelRow(super().Get(item1))
8731
8732		if isinstance(item1, int):
8733			return LoadPropertyUserFeaPanelRow(super().Get(item1))
8734
8735		return LoadPropertyUserFeaPanelRow(self._Entity.Get(item1))
8736
8737	def __getitem__(self, index: int):
8738		return self.LoadPropertyUserFeaPanelRowColList[index]
8739
8740	def __iter__(self):
8741		yield from self.LoadPropertyUserFeaPanelRowColList
8742
8743	def __len__(self):
8744		return len(self.LoadPropertyUserFeaPanelRowColList)
8745
8746
8747class LoadPropertyUserFeaPanel(LoadProperty):
8748	def __init__(self, loadPropertyUserFeaPanel: _api.LoadPropertyUserFeaPanel):
8749		self._Entity = loadPropertyUserFeaPanel
8750
8751	@property
8752	def UserFeaRows(self) -> LoadPropertyUserFeaPanelRowCol:
8753		result = self._Entity.UserFeaRows
8754		return LoadPropertyUserFeaPanelRowCol(result) if result is not None else None
8755
8756	def SetIsZeroCurvature(self, isZeroCurvature: bool) -> None:
8757		return self._Entity.SetIsZeroCurvature(isZeroCurvature)
8758
8759
8760class LoadPropertyUserGeneralDoubleRow(IdNameEntity):
8761	def __init__(self, loadPropertyUserGeneralDoubleRow: _api.LoadPropertyUserGeneralDoubleRow):
8762		self._Entity = loadPropertyUserGeneralDoubleRow
8763
8764	@property
8765	def MechanicalRow(self) -> LoadPropertyUserRow:
8766		thisClass = type(self._Entity.MechanicalRow).__name__
8767		givenClass = LoadPropertyUserRow
8768		for subclass in LoadPropertyUserRow.__subclasses__():
8769			if subclass.__name__ == thisClass:
8770				givenClass = subclass
8771		result = self._Entity.MechanicalRow
8772		return givenClass(result) if result is not None else None
8773
8774	@property
8775	def ThermalRow(self) -> LoadPropertyUserRow:
8776		thisClass = type(self._Entity.ThermalRow).__name__
8777		givenClass = LoadPropertyUserRow
8778		for subclass in LoadPropertyUserRow.__subclasses__():
8779			if subclass.__name__ == thisClass:
8780				givenClass = subclass
8781		result = self._Entity.ThermalRow
8782		return givenClass(result) if result is not None else None
8783
8784	def SetName(self, name: str) -> None:
8785		return self._Entity.SetName(name)
8786
8787
8788class LoadPropertyUserGeneralBeamDoubleRow(LoadPropertyUserGeneralDoubleRow):
8789	def __init__(self, loadPropertyUserGeneralBeamDoubleRow: _api.LoadPropertyUserGeneralBeamDoubleRow):
8790		self._Entity = loadPropertyUserGeneralBeamDoubleRow
8791
8792	@property
8793	def MechanicalRow(self) -> LoadPropertyUserRow:
8794		thisClass = type(self._Entity.MechanicalRow).__name__
8795		givenClass = LoadPropertyUserRow
8796		for subclass in LoadPropertyUserRow.__subclasses__():
8797			if subclass.__name__ == thisClass:
8798				givenClass = subclass
8799		result = self._Entity.MechanicalRow
8800		return givenClass(result) if result is not None else None
8801
8802	@property
8803	def ThermalRow(self) -> LoadPropertyUserRow:
8804		thisClass = type(self._Entity.ThermalRow).__name__
8805		givenClass = LoadPropertyUserRow
8806		for subclass in LoadPropertyUserRow.__subclasses__():
8807			if subclass.__name__ == thisClass:
8808				givenClass = subclass
8809		result = self._Entity.ThermalRow
8810		return givenClass(result) if result is not None else None
8811
8812	@property
8813	def M1AType(self) -> types.BoundaryConditionType:
8814		return types.BoundaryConditionType[self._Entity.M1AType.ToString()]
8815
8816	@property
8817	def M2AType(self) -> types.BoundaryConditionType:
8818		return types.BoundaryConditionType[self._Entity.M2AType.ToString()]
8819
8820	@property
8821	def M1BType(self) -> types.BoundaryConditionType:
8822		return types.BoundaryConditionType[self._Entity.M1BType.ToString()]
8823
8824	@property
8825	def M2BType(self) -> types.BoundaryConditionType:
8826		return types.BoundaryConditionType[self._Entity.M2BType.ToString()]
8827
8828	@property
8829	def V1Type(self) -> types.BoundaryConditionType:
8830		return types.BoundaryConditionType[self._Entity.V1Type.ToString()]
8831
8832	@property
8833	def V2Type(self) -> types.BoundaryConditionType:
8834		return types.BoundaryConditionType[self._Entity.V2Type.ToString()]
8835
8836	@property
8837	def AxialType(self) -> types.BoundaryConditionType:
8838		return types.BoundaryConditionType[self._Entity.AxialType.ToString()]
8839
8840	@property
8841	def TorqueType(self) -> types.BoundaryConditionType:
8842		return types.BoundaryConditionType[self._Entity.TorqueType.ToString()]
8843
8844	def SetM1AType(self, type: types.BoundaryConditionType) -> None:
8845		return self._Entity.SetM1AType(_types.BoundaryConditionType(type.value))
8846
8847	def SetM2AType(self, type: types.BoundaryConditionType) -> None:
8848		return self._Entity.SetM2AType(_types.BoundaryConditionType(type.value))
8849
8850	def SetM1BType(self, type: types.BoundaryConditionType) -> None:
8851		return self._Entity.SetM1BType(_types.BoundaryConditionType(type.value))
8852
8853	def SetM2BType(self, type: types.BoundaryConditionType) -> None:
8854		return self._Entity.SetM2BType(_types.BoundaryConditionType(type.value))
8855
8856	def SetV1Type(self, type: types.BoundaryConditionType) -> None:
8857		return self._Entity.SetV1Type(_types.BoundaryConditionType(type.value))
8858
8859	def SetV2Type(self, type: types.BoundaryConditionType) -> None:
8860		return self._Entity.SetV2Type(_types.BoundaryConditionType(type.value))
8861
8862	def SetAxialType(self, type: types.BoundaryConditionType) -> None:
8863		return self._Entity.SetAxialType(_types.BoundaryConditionType(type.value))
8864
8865	def SetTorqueType(self, type: types.BoundaryConditionType) -> None:
8866		return self._Entity.SetTorqueType(_types.BoundaryConditionType(type.value))
8867
8868
8869class LoadPropertyUserGeneralRowCol(IdNameEntityCol, Generic[T]):
8870	def __init__(self, loadPropertyUserGeneralRowCol: _api.LoadPropertyUserGeneralRowCol):
8871		self._Entity = loadPropertyUserGeneralRowCol
8872		self._CollectedClass = T
8873
8874	@property
8875	def LoadPropertyUserGeneralRowColList(self) -> tuple[T]:
8876		if self._Entity.Count() <= 0:
8877			return ()
8878		thisClass = type(self._Entity._items[0]).__name__
8879		givenClass = T
8880		for subclass in T.__subclasses__():
8881			if subclass.__name__ == thisClass:
8882				givenClass = subclass
8883		return tuple([givenClass(loadPropertyUserGeneralRowCol) for loadPropertyUserGeneralRowCol in self._Entity])
8884
8885	def AddScenario(self, name: str = None) -> T:
8886		return self._Entity.AddScenario(name)
8887
8888	@overload
8889	def DeleteScenario(self, scenarioId: int) -> bool: ...
8890
8891	@overload
8892	def DeleteScenario(self, scenarioName: str) -> bool: ...
8893
8894	@overload
8895	def Get(self, name: str) -> T: ...
8896
8897	@overload
8898	def Get(self, id: int) -> T: ...
8899
8900	def DeleteScenario(self, item1 = None) -> bool:
8901		if isinstance(item1, int):
8902			return self._Entity.DeleteScenario(item1)
8903
8904		if isinstance(item1, str):
8905			return self._Entity.DeleteScenario(item1)
8906
8907		return self._Entity.DeleteScenario(item1)
8908
8909	def Get(self, item1 = None) -> T:
8910		if isinstance(item1, str):
8911			return super().Get(item1)
8912
8913		if isinstance(item1, int):
8914			return super().Get(item1)
8915
8916		return self._Entity.Get(item1)
8917
8918	def __getitem__(self, index: int):
8919		return self.LoadPropertyUserGeneralRowColList[index]
8920
8921	def __iter__(self):
8922		yield from self.LoadPropertyUserGeneralRowColList
8923
8924	def __len__(self):
8925		return len(self.LoadPropertyUserGeneralRowColList)
8926
8927
8928class LoadPropertyUserGeneralBeamRowCol(LoadPropertyUserGeneralRowCol[LoadPropertyUserGeneralBeamDoubleRow]):
8929	def __init__(self, loadPropertyUserGeneralBeamRowCol: _api.LoadPropertyUserGeneralBeamRowCol):
8930		self._Entity = loadPropertyUserGeneralBeamRowCol
8931		self._CollectedClass = LoadPropertyUserGeneralBeamDoubleRow
8932
8933	@property
8934	def LoadPropertyUserGeneralBeamRowColList(self) -> tuple[LoadPropertyUserGeneralBeamDoubleRow]:
8935		return tuple([LoadPropertyUserGeneralBeamDoubleRow(loadPropertyUserGeneralBeamRowCol) for loadPropertyUserGeneralBeamRowCol in self._Entity])
8936
8937	@overload
8938	def DeleteScenario(self, scenarioId: int) -> bool: ...
8939
8940	@overload
8941	def DeleteScenario(self, scenarioName: str) -> bool: ...
8942
8943	@overload
8944	def Get(self, name: str) -> LoadPropertyUserGeneralBeamDoubleRow: ...
8945
8946	@overload
8947	def Get(self, id: int) -> LoadPropertyUserGeneralBeamDoubleRow: ...
8948
8949	def DeleteScenario(self, item1 = None) -> bool:
8950		if isinstance(item1, int):
8951			return bool(super().DeleteScenario(item1))
8952
8953		if isinstance(item1, str):
8954			return bool(super().DeleteScenario(item1))
8955
8956		return self._Entity.DeleteScenario(item1)
8957
8958	def Get(self, item1 = None) -> LoadPropertyUserGeneralBeamDoubleRow:
8959		if isinstance(item1, str):
8960			return LoadPropertyUserGeneralBeamDoubleRow(super().Get(item1))
8961
8962		if isinstance(item1, int):
8963			return LoadPropertyUserGeneralBeamDoubleRow(super().Get(item1))
8964
8965		return LoadPropertyUserGeneralBeamDoubleRow(self._Entity.Get(item1))
8966
8967	def __getitem__(self, index: int):
8968		return self.LoadPropertyUserGeneralBeamRowColList[index]
8969
8970	def __iter__(self):
8971		yield from self.LoadPropertyUserGeneralBeamRowColList
8972
8973	def __len__(self):
8974		return len(self.LoadPropertyUserGeneralBeamRowColList)
8975
8976
8977class LoadPropertyUserGeneralBeam(LoadProperty):
8978	def __init__(self, loadPropertyUserGeneralBeam: _api.LoadPropertyUserGeneralBeam):
8979		self._Entity = loadPropertyUserGeneralBeam
8980
8981	@property
8982	def UserGeneralRows(self) -> LoadPropertyUserGeneralBeamRowCol:
8983		result = self._Entity.UserGeneralRows
8984		return LoadPropertyUserGeneralBeamRowCol(result) if result is not None else None
8985
8986	@property
8987	def IsIncludingThermal(self) -> bool:
8988		return self._Entity.IsIncludingThermal
8989
8990	@IsIncludingThermal.setter
8991	def IsIncludingThermal(self, value: bool) -> None:
8992		self._Entity.IsIncludingThermal = value
8993
8994
8995class LoadPropertyUserGeneralBoltedRow(IdEntity):
8996	def __init__(self, loadPropertyUserGeneralBoltedRow: _api.LoadPropertyUserGeneralBoltedRow):
8997		self._Entity = loadPropertyUserGeneralBoltedRow
8998
8999	@property
9000	def LoadPropertyId(self) -> int:
9001		return self._Entity.LoadPropertyId
9002
9003	@property
9004	def LoadScenarioId(self) -> int:
9005		return self._Entity.LoadScenarioId
9006
9007	@property
9008	def Fx(self) -> float:
9009		return self._Entity.Fx
9010
9011	@property
9012	def Fy(self) -> float:
9013		return self._Entity.Fy
9014
9015	@property
9016	def Fz(self) -> float:
9017		return self._Entity.Fz
9018
9019	@property
9020	def Mx(self) -> float:
9021		return self._Entity.Mx
9022
9023	@property
9024	def My(self) -> float:
9025		return self._Entity.My
9026
9027	@property
9028	def Mz(self) -> float:
9029		return self._Entity.Mz
9030
9031	@property
9032	def NxBypass(self) -> float:
9033		return self._Entity.NxBypass
9034
9035	@property
9036	def NyBypass(self) -> float:
9037		return self._Entity.NyBypass
9038
9039	@property
9040	def NxyBypass(self) -> float:
9041		return self._Entity.NxyBypass
9042
9043	@property
9044	def LimitFactor(self) -> float:
9045		return self._Entity.LimitFactor
9046
9047	@property
9048	def UltimateFactor(self) -> float:
9049		return self._Entity.UltimateFactor
9050
9051	@Fx.setter
9052	def Fx(self, value: float) -> None:
9053		self._Entity.Fx = value
9054
9055	@Fy.setter
9056	def Fy(self, value: float) -> None:
9057		self._Entity.Fy = value
9058
9059	@Fz.setter
9060	def Fz(self, value: float) -> None:
9061		self._Entity.Fz = value
9062
9063	@Mx.setter
9064	def Mx(self, value: float) -> None:
9065		self._Entity.Mx = value
9066
9067	@My.setter
9068	def My(self, value: float) -> None:
9069		self._Entity.My = value
9070
9071	@Mz.setter
9072	def Mz(self, value: float) -> None:
9073		self._Entity.Mz = value
9074
9075	@NxBypass.setter
9076	def NxBypass(self, value: float) -> None:
9077		self._Entity.NxBypass = value
9078
9079	@NyBypass.setter
9080	def NyBypass(self, value: float) -> None:
9081		self._Entity.NyBypass = value
9082
9083	@NxyBypass.setter
9084	def NxyBypass(self, value: float) -> None:
9085		self._Entity.NxyBypass = value
9086
9087	@LimitFactor.setter
9088	def LimitFactor(self, value: float) -> None:
9089		self._Entity.LimitFactor = value
9090
9091	@UltimateFactor.setter
9092	def UltimateFactor(self, value: float) -> None:
9093		self._Entity.UltimateFactor = value
9094
9095
9096class LoadPropertyUserGeneralBoltedRowCol(IdEntityCol[LoadPropertyUserGeneralBoltedRow]):
9097	def __init__(self, loadPropertyUserGeneralBoltedRowCol: _api.LoadPropertyUserGeneralBoltedRowCol):
9098		self._Entity = loadPropertyUserGeneralBoltedRowCol
9099		self._CollectedClass = LoadPropertyUserGeneralBoltedRow
9100
9101	@property
9102	def LoadPropertyUserGeneralBoltedRowColList(self) -> tuple[LoadPropertyUserGeneralBoltedRow]:
9103		return tuple([LoadPropertyUserGeneralBoltedRow(loadPropertyUserGeneralBoltedRowCol) for loadPropertyUserGeneralBoltedRowCol in self._Entity])
9104
9105	def AddScenario(self) -> None:
9106		'''
9107		Adds a load scenario with default values
9108		'''
9109		return self._Entity.AddScenario()
9110
9111	def DeleteScenario(self, scenarioId: int) -> bool:
9112		return self._Entity.DeleteScenario(scenarioId)
9113
9114	def __getitem__(self, index: int):
9115		return self.LoadPropertyUserGeneralBoltedRowColList[index]
9116
9117	def __iter__(self):
9118		yield from self.LoadPropertyUserGeneralBoltedRowColList
9119
9120	def __len__(self):
9121		return len(self.LoadPropertyUserGeneralBoltedRowColList)
9122
9123
9124class LoadPropertyUserGeneralBolted(LoadProperty):
9125	def __init__(self, loadPropertyUserGeneralBolted: _api.LoadPropertyUserGeneralBolted):
9126		self._Entity = loadPropertyUserGeneralBolted
9127
9128	@property
9129	def UserGeneralBoltedRows(self) -> LoadPropertyUserGeneralBoltedRowCol:
9130		result = self._Entity.UserGeneralBoltedRows
9131		return LoadPropertyUserGeneralBoltedRowCol(result) if result is not None else None
9132
9133
9134class LoadPropertyUserGeneralBondedRow(IdEntity):
9135	def __init__(self, loadPropertyUserGeneralBondedRow: _api.LoadPropertyUserGeneralBondedRow):
9136		self._Entity = loadPropertyUserGeneralBondedRow
9137
9138	@property
9139	def LoadPropertyId(self) -> int:
9140		return self._Entity.LoadPropertyId
9141
9142	@property
9143	def JointConceptId(self) -> types.JointConceptId:
9144		return types.JointConceptId[self._Entity.JointConceptId.ToString()]
9145
9146	@property
9147	def BondedBcId(self) -> int:
9148		return self._Entity.BondedBcId
9149
9150	@property
9151	def AxialType(self) -> types.BoundaryConditionType:
9152		return types.BoundaryConditionType[self._Entity.AxialType.ToString()]
9153
9154	@property
9155	def MomentType(self) -> types.BoundaryConditionType:
9156		return types.BoundaryConditionType[self._Entity.MomentType.ToString()]
9157
9158	@property
9159	def TransverseType(self) -> types.BoundaryConditionType:
9160		return types.BoundaryConditionType[self._Entity.TransverseType.ToString()]
9161
9162	@property
9163	def ShearType(self) -> types.BoundaryConditionType:
9164		return types.BoundaryConditionType[self._Entity.ShearType.ToString()]
9165
9166	@property
9167	def Axial(self) -> float:
9168		return self._Entity.Axial
9169
9170	@property
9171	def Moment(self) -> float:
9172		return self._Entity.Moment
9173
9174	@property
9175	def Transverse(self) -> float:
9176		return self._Entity.Transverse
9177
9178	@property
9179	def Shear(self) -> float:
9180		return self._Entity.Shear
9181
9182	@AxialType.setter
9183	def AxialType(self, value: types.BoundaryConditionType) -> None:
9184		self._Entity.AxialType = _types.BoundaryConditionType(value.value)
9185
9186	@MomentType.setter
9187	def MomentType(self, value: types.BoundaryConditionType) -> None:
9188		self._Entity.MomentType = _types.BoundaryConditionType(value.value)
9189
9190	@TransverseType.setter
9191	def TransverseType(self, value: types.BoundaryConditionType) -> None:
9192		self._Entity.TransverseType = _types.BoundaryConditionType(value.value)
9193
9194	@ShearType.setter
9195	def ShearType(self, value: types.BoundaryConditionType) -> None:
9196		self._Entity.ShearType = _types.BoundaryConditionType(value.value)
9197
9198	@Axial.setter
9199	def Axial(self, value: float) -> None:
9200		self._Entity.Axial = value
9201
9202	@Moment.setter
9203	def Moment(self, value: float) -> None:
9204		self._Entity.Moment = value
9205
9206	@Transverse.setter
9207	def Transverse(self, value: float) -> None:
9208		self._Entity.Transverse = value
9209
9210	@Shear.setter
9211	def Shear(self, value: float) -> None:
9212		self._Entity.Shear = value
9213
9214	def UpdateRow(self) -> None:
9215		return self._Entity.UpdateRow()
9216
9217
9218class LoadPropertyUserGeneralBondedRowCol(IdEntityCol[LoadPropertyUserGeneralBondedRow]):
9219	def __init__(self, loadPropertyUserGeneralBondedRowCol: _api.LoadPropertyUserGeneralBondedRowCol):
9220		self._Entity = loadPropertyUserGeneralBondedRowCol
9221		self._CollectedClass = LoadPropertyUserGeneralBondedRow
9222
9223	@property
9224	def LoadPropertyUserGeneralBondedRowColList(self) -> tuple[LoadPropertyUserGeneralBondedRow]:
9225		return tuple([LoadPropertyUserGeneralBondedRow(loadPropertyUserGeneralBondedRowCol) for loadPropertyUserGeneralBondedRowCol in self._Entity])
9226
9227	def __getitem__(self, index: int):
9228		return self.LoadPropertyUserGeneralBondedRowColList[index]
9229
9230	def __iter__(self):
9231		yield from self.LoadPropertyUserGeneralBondedRowColList
9232
9233	def __len__(self):
9234		return len(self.LoadPropertyUserGeneralBondedRowColList)
9235
9236
9237class LoadPropertyJoint(IdEntity):
9238	def __init__(self, loadPropertyJoint: _api.LoadPropertyJoint):
9239		self._Entity = loadPropertyJoint
9240
9241	@property
9242	def UserGeneralBondedRows(self) -> LoadPropertyUserGeneralBondedRowCol:
9243		result = self._Entity.UserGeneralBondedRows
9244		return LoadPropertyUserGeneralBondedRowCol(result) if result is not None else None
9245
9246	@property
9247	def LoadPropertyId(self) -> int:
9248		return self._Entity.LoadPropertyId
9249
9250	@property
9251	def JConceptId(self) -> types.JointConceptId:
9252		return types.JointConceptId[self._Entity.JConceptId.ToString()]
9253
9254	@property
9255	def Ex(self) -> float:
9256		return self._Entity.Ex
9257
9258	@property
9259	def Kx(self) -> float:
9260		return self._Entity.Kx
9261
9262	@property
9263	def Kxy(self) -> float:
9264		return self._Entity.Kxy
9265
9266	@property
9267	def Temperature(self) -> float:
9268		return self._Entity.Temperature
9269
9270	@JConceptId.setter
9271	def JConceptId(self, value: types.JointConceptId) -> None:
9272		self._Entity.JConceptId = _types.JointConceptId(value.value)
9273
9274	@Ex.setter
9275	def Ex(self, value: float) -> None:
9276		self._Entity.Ex = value
9277
9278	@Kx.setter
9279	def Kx(self, value: float) -> None:
9280		self._Entity.Kx = value
9281
9282	@Kxy.setter
9283	def Kxy(self, value: float) -> None:
9284		self._Entity.Kxy = value
9285
9286	@Temperature.setter
9287	def Temperature(self, value: float) -> None:
9288		self._Entity.Temperature = value
9289
9290
9291class LoadPropertyUserGeneralBonded(LoadProperty):
9292	def __init__(self, loadPropertyUserGeneralBonded: _api.LoadPropertyUserGeneralBonded):
9293		self._Entity = loadPropertyUserGeneralBonded
9294
9295	@property
9296	def LoadPropertyJoint(self) -> LoadPropertyJoint:
9297		result = self._Entity.LoadPropertyJoint
9298		return LoadPropertyJoint(result) if result is not None else None
9299
9300
9301class LoadPropertyUserGeneralPanelDoubleRow(LoadPropertyUserGeneralDoubleRow):
9302	def __init__(self, loadPropertyUserGeneralPanelDoubleRow: _api.LoadPropertyUserGeneralPanelDoubleRow):
9303		self._Entity = loadPropertyUserGeneralPanelDoubleRow
9304
9305	@property
9306	def MechanicalRow(self) -> LoadPropertyUserRow:
9307		thisClass = type(self._Entity.MechanicalRow).__name__
9308		givenClass = LoadPropertyUserRow
9309		for subclass in LoadPropertyUserRow.__subclasses__():
9310			if subclass.__name__ == thisClass:
9311				givenClass = subclass
9312		result = self._Entity.MechanicalRow
9313		return givenClass(result) if result is not None else None
9314
9315	@property
9316	def ThermalRow(self) -> LoadPropertyUserRow:
9317		thisClass = type(self._Entity.ThermalRow).__name__
9318		givenClass = LoadPropertyUserRow
9319		for subclass in LoadPropertyUserRow.__subclasses__():
9320			if subclass.__name__ == thisClass:
9321				givenClass = subclass
9322		result = self._Entity.ThermalRow
9323		return givenClass(result) if result is not None else None
9324
9325	@property
9326	def NxType(self) -> types.BoundaryConditionType:
9327		return types.BoundaryConditionType[self._Entity.NxType.ToString()]
9328
9329	@property
9330	def NyType(self) -> types.BoundaryConditionType:
9331		return types.BoundaryConditionType[self._Entity.NyType.ToString()]
9332
9333	@property
9334	def NxyType(self) -> types.BoundaryConditionType:
9335		return types.BoundaryConditionType[self._Entity.NxyType.ToString()]
9336
9337	@property
9338	def MxType(self) -> types.BoundaryConditionType:
9339		return types.BoundaryConditionType[self._Entity.MxType.ToString()]
9340
9341	@property
9342	def MyType(self) -> types.BoundaryConditionType:
9343		return types.BoundaryConditionType[self._Entity.MyType.ToString()]
9344
9345	@property
9346	def MxyType(self) -> types.BoundaryConditionType:
9347		return types.BoundaryConditionType[self._Entity.MxyType.ToString()]
9348
9349	@property
9350	def QxType(self) -> types.BoundaryConditionType:
9351		return types.BoundaryConditionType[self._Entity.QxType.ToString()]
9352
9353	@property
9354	def QyType(self) -> types.BoundaryConditionType:
9355		return types.BoundaryConditionType[self._Entity.QyType.ToString()]
9356
9357	def SetNxType(self, type: types.BoundaryConditionType) -> None:
9358		return self._Entity.SetNxType(_types.BoundaryConditionType(type.value))
9359
9360	def SetNyType(self, type: types.BoundaryConditionType) -> None:
9361		return self._Entity.SetNyType(_types.BoundaryConditionType(type.value))
9362
9363	def SetNxyType(self, type: types.BoundaryConditionType) -> None:
9364		return self._Entity.SetNxyType(_types.BoundaryConditionType(type.value))
9365
9366	def SetMxType(self, type: types.BoundaryConditionType) -> None:
9367		return self._Entity.SetMxType(_types.BoundaryConditionType(type.value))
9368
9369	def SetMyType(self, type: types.BoundaryConditionType) -> None:
9370		return self._Entity.SetMyType(_types.BoundaryConditionType(type.value))
9371
9372	def SetMxyType(self, type: types.BoundaryConditionType) -> None:
9373		return self._Entity.SetMxyType(_types.BoundaryConditionType(type.value))
9374
9375	def SetQxType(self, type: types.BoundaryConditionType) -> None:
9376		return self._Entity.SetQxType(_types.BoundaryConditionType(type.value))
9377
9378	def SetQyType(self, type: types.BoundaryConditionType) -> None:
9379		return self._Entity.SetQyType(_types.BoundaryConditionType(type.value))
9380
9381
9382class LoadPropertyUserGeneralPanelRowCol(LoadPropertyUserGeneralRowCol[LoadPropertyUserGeneralPanelDoubleRow]):
9383	def __init__(self, loadPropertyUserGeneralPanelRowCol: _api.LoadPropertyUserGeneralPanelRowCol):
9384		self._Entity = loadPropertyUserGeneralPanelRowCol
9385		self._CollectedClass = LoadPropertyUserGeneralPanelDoubleRow
9386
9387	@property
9388	def LoadPropertyUserGeneralPanelRowColList(self) -> tuple[LoadPropertyUserGeneralPanelDoubleRow]:
9389		return tuple([LoadPropertyUserGeneralPanelDoubleRow(loadPropertyUserGeneralPanelRowCol) for loadPropertyUserGeneralPanelRowCol in self._Entity])
9390
9391	@overload
9392	def DeleteScenario(self, scenarioId: int) -> bool: ...
9393
9394	@overload
9395	def DeleteScenario(self, scenarioName: str) -> bool: ...
9396
9397	@overload
9398	def Get(self, name: str) -> LoadPropertyUserGeneralPanelDoubleRow: ...
9399
9400	@overload
9401	def Get(self, id: int) -> LoadPropertyUserGeneralPanelDoubleRow: ...
9402
9403	def DeleteScenario(self, item1 = None) -> bool:
9404		if isinstance(item1, int):
9405			return bool(super().DeleteScenario(item1))
9406
9407		if isinstance(item1, str):
9408			return bool(super().DeleteScenario(item1))
9409
9410		return self._Entity.DeleteScenario(item1)
9411
9412	def Get(self, item1 = None) -> LoadPropertyUserGeneralPanelDoubleRow:
9413		if isinstance(item1, str):
9414			return LoadPropertyUserGeneralPanelDoubleRow(super().Get(item1))
9415
9416		if isinstance(item1, int):
9417			return LoadPropertyUserGeneralPanelDoubleRow(super().Get(item1))
9418
9419		return LoadPropertyUserGeneralPanelDoubleRow(self._Entity.Get(item1))
9420
9421	def __getitem__(self, index: int):
9422		return self.LoadPropertyUserGeneralPanelRowColList[index]
9423
9424	def __iter__(self):
9425		yield from self.LoadPropertyUserGeneralPanelRowColList
9426
9427	def __len__(self):
9428		return len(self.LoadPropertyUserGeneralPanelRowColList)
9429
9430
9431class LoadPropertyUserGeneralPanel(LoadProperty):
9432	def __init__(self, loadPropertyUserGeneralPanel: _api.LoadPropertyUserGeneralPanel):
9433		self._Entity = loadPropertyUserGeneralPanel
9434
9435	@property
9436	def UserGeneralRows(self) -> LoadPropertyUserGeneralPanelRowCol:
9437		result = self._Entity.UserGeneralRows
9438		return LoadPropertyUserGeneralPanelRowCol(result) if result is not None else None
9439
9440	@property
9441	def IsIncludingThermal(self) -> bool:
9442		return self._Entity.IsIncludingThermal
9443
9444	@IsIncludingThermal.setter
9445	def IsIncludingThermal(self, value: bool) -> None:
9446		self._Entity.IsIncludingThermal = value
9447
9448	def SetIsZeroCurvature(self, isZeroCurvature: bool) -> None:
9449		return self._Entity.SetIsZeroCurvature(isZeroCurvature)
9450
9451
9452class JointSelectionDesignResult(JointDesignResult):
9453	def __init__(self, jointSelectionDesignResult: _api.JointSelectionDesignResult):
9454		self._Entity = jointSelectionDesignResult
9455
9456	@property
9457	def JointSelectionId(self) -> types.JointSelectionId:
9458		return types.JointSelectionId[self._Entity.JointSelectionId.ToString()]
9459
9460
9461class JointFastenerDesignResult(JointSelectionDesignResult):
9462	def __init__(self, jointFastenerDesignResult: _api.JointFastenerDesignResult):
9463		self._Entity = jointFastenerDesignResult
9464
9465	@property
9466	def FastenerBoltId(self) -> int:
9467		return self._Entity.FastenerBoltId
9468
9469	@property
9470	def FastenerCodeId(self) -> int:
9471		return self._Entity.FastenerCodeId
9472
9473
9474class JointMaterialDesignResult(JointSelectionDesignResult):
9475	def __init__(self, jointMaterialDesignResult: _api.JointMaterialDesignResult):
9476		self._Entity = jointMaterialDesignResult
9477
9478	@property
9479	def MaterialId(self) -> int:
9480		return self._Entity.MaterialId
9481
9482	@property
9483	def MaterialType(self) -> types.MaterialType:
9484		'''
9485		Represents a material's type.
9486		'''
9487		return types.MaterialType[self._Entity.MaterialType.ToString()]
9488
9489
9490class JointRangeDesignResult(JointDesignResult):
9491	def __init__(self, jointRangeDesignResult: _api.JointRangeDesignResult):
9492		self._Entity = jointRangeDesignResult
9493
9494	@property
9495	def JointRangeId(self) -> types.JointRangeId:
9496		return types.JointRangeId[self._Entity.JointRangeId.ToString()]
9497
9498	@property
9499	def Value(self) -> float:
9500		return self._Entity.Value
9501
9502
9503class JointRivetDesignResult(JointSelectionDesignResult):
9504	def __init__(self, jointRivetDesignResult: _api.JointRivetDesignResult):
9505		self._Entity = jointRivetDesignResult
9506
9507	@property
9508	def RivetId(self) -> int:
9509		return self._Entity.RivetId
9510
9511	@property
9512	def RivetDiameterId(self) -> int:
9513		return self._Entity.RivetDiameterId
9514
9515
9516class Environment(ABC):
9517	'''
9518	Represents HyperX's execution environment (where HyperX is installed).
9519	'''
9520	def __init__(self, environment: _api.Environment):
9521		self._Entity = environment
9522
9523	def SetLocation(location: str) -> None:
9524		return _api.Environment.SetLocation(location)
9525
9526	def Initialize() -> None:
9527		'''
9528		Initialize the HyperX scripting environment.
9529		'''
9530		return _api.Environment.Initialize()
9531
9532
9533class FailureCriterionSetting(FailureSetting):
9534	'''
9535	Setting for a Failure Criteria.
9536	'''
9537	def __init__(self, failureCriterionSetting: _api.FailureCriterionSetting):
9538		self._Entity = failureCriterionSetting
9539
9540
9541class FailureModeSetting(FailureSetting):
9542	'''
9543	Setting for a Failure Mode.
9544	'''
9545	def __init__(self, failureModeSetting: _api.FailureModeSetting):
9546		self._Entity = failureModeSetting
9547
9548
9549class HelperFunctions(ABC):
9550	def __init__(self, helperFunctions: _api.HelperFunctions):
9551		self._Entity = helperFunctions
9552
9553	def NullableSingle(input: float) -> float:
9554		return _api.HelperFunctions.NullableSingle(input)
9555
9556
9557class IBulkUpdatableEntity:
9558	def __init__(self, iBulkUpdatableEntity: _api.IBulkUpdatableEntity):
9559		self._Entity = iBulkUpdatableEntity
9560
9561	pass
9562
9563
9564class LaminatePlyData:
9565	'''
9566	Per ply data for Laminate materials
9567	'''
9568	def __init__(self, laminatePlyData: _api.LaminatePlyData):
9569		self._Entity = laminatePlyData
9570
9571	@property
9572	def MaterialId(self) -> int:
9573		return self._Entity.MaterialId
9574
9575	@property
9576	def PlyId(self) -> int:
9577		return self._Entity.PlyId
9578
9579	@property
9580	def PlyMaterialId(self) -> int:
9581		return self._Entity.PlyMaterialId
9582
9583	@property
9584	def PlyMaterialType(self) -> types.MaterialType:
9585		'''
9586		Represents a material's type.
9587		'''
9588		return types.MaterialType[self._Entity.PlyMaterialType.ToString()]
9589
9590	@property
9591	def Angle(self) -> float:
9592		return self._Entity.Angle
9593
9594	@property
9595	def Thickness(self) -> float:
9596		return self._Entity.Thickness
9597
9598	@property
9599	def IsFabric(self) -> bool:
9600		return self._Entity.IsFabric
9601
9602	@property
9603	def FamilyPlyId(self) -> int:
9604		return self._Entity.FamilyPlyId
9605
9606	@property
9607	def OriginalPlyId(self) -> int:
9608		return self._Entity.OriginalPlyId
9609
9610	@property
9611	def OriginalFamilyPlyId(self) -> int:
9612		return self._Entity.OriginalFamilyPlyId
9613
9614	@property
9615	def DisplaySequenceId(self) -> int:
9616		return self._Entity.DisplaySequenceId
9617
9618	@property
9619	def PlyStiffenerSubType(self) -> types.PlyStiffenerSubType:
9620		return types.PlyStiffenerSubType[self._Entity.PlyStiffenerSubType.ToString()]
9621
9622	@property
9623	def Object1(self) -> bool:
9624		return self._Entity.Object1
9625
9626	@property
9627	def Object2(self) -> bool:
9628		return self._Entity.Object2
9629
9630	@property
9631	def Object3(self) -> bool:
9632		return self._Entity.Object3
9633
9634	@property
9635	def IsInverted(self) -> bool:
9636		return self._Entity.IsInverted
9637
9638	@property
9639	def IsFullStructure(self) -> bool:
9640		return self._Entity.IsFullStructure
9641
9642	@property
9643	def UseTrueFiberDirection(self) -> bool:
9644		return self._Entity.UseTrueFiberDirection
9645
9646	@property
9647	def IsInFoot(self) -> bool:
9648		return self._Entity.IsInFoot
9649
9650	@property
9651	def IsInWeb(self) -> bool:
9652		return self._Entity.IsInWeb
9653
9654	@property
9655	def IsInCap(self) -> bool:
9656		return self._Entity.IsInCap
9657
9658	def SetMaterial(self, matId: int) -> bool:
9659		return self._Entity.SetMaterial(matId)
9660
9661	def SetAngle(self, angle: float) -> bool:
9662		return self._Entity.SetAngle(angle)
9663
9664
9665class Beam(Zone):
9666	def __init__(self, beam: _api.Beam):
9667		self._Entity = beam
9668
9669	@property
9670	def Length(self) -> float:
9671		return self._Entity.Length
9672
9673	@property
9674	def Phi(self) -> float:
9675		return self._Entity.Phi
9676
9677	@property
9678	def K1(self) -> float:
9679		return self._Entity.K1
9680
9681	@property
9682	def K2(self) -> float:
9683		return self._Entity.K2
9684
9685	@property
9686	def ReferencePlane(self) -> types.ReferencePlaneBeam:
9687		return types.ReferencePlaneBeam[self._Entity.ReferencePlane.ToString()]
9688
9689	@Phi.setter
9690	def Phi(self, value: float) -> None:
9691		self._Entity.Phi = value
9692
9693	@K1.setter
9694	def K1(self, value: float) -> None:
9695		self._Entity.K1 = value
9696
9697	@K2.setter
9698	def K2(self, value: float) -> None:
9699		self._Entity.K2 = value
9700
9701	@ReferencePlane.setter
9702	def ReferencePlane(self, value: types.ReferencePlaneBeam) -> None:
9703		self._Entity.ReferencePlane = _types.ReferencePlaneBeam(value.value)
9704
9705
9706class ZoneBulkUpdaterBase(BulkUpdaterBase):
9707	def __init__(self, zoneBulkUpdaterBase: _api.ZoneBulkUpdaterBase):
9708		self._Entity = zoneBulkUpdaterBase
9709
9710
9711class BeamBulkUpdater(ZoneBulkUpdaterBase):
9712	def __init__(self, beamBulkUpdater: _api.BeamBulkUpdater):
9713		self._Entity = beamBulkUpdater
9714
9715	def GetBulkUpdater(application: Application, items: list[Beam]) -> BeamBulkUpdater:
9716		itemsList = List[_api.Beam]()
9717		if items is not None:
9718			for thing in items:
9719				if thing is not None:
9720					itemsList.Add(thing._Entity)
9721		return BeamBulkUpdater(_api.BeamBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
9722
9723
9724class Panel(Zone):
9725	def __init__(self, panel: _api.Panel):
9726		self._Entity = panel
9727
9728	@property
9729	def Area(self) -> float:
9730		return self._Entity.Area
9731
9732	@property
9733	def ReferencePlane(self) -> types.ReferencePlanePanel:
9734		return types.ReferencePlanePanel[self._Entity.ReferencePlane.ToString()]
9735
9736	@property
9737	def AddedOffset(self) -> float:
9738		return self._Entity.AddedOffset
9739
9740	@property
9741	def YSpan(self) -> float:
9742		return self._Entity.YSpan
9743
9744	@property
9745	def IsCurved(self) -> bool:
9746		return self._Entity.IsCurved
9747
9748	@property
9749	def Radius(self) -> float:
9750		return self._Entity.Radius
9751
9752	@property
9753	def IsFullCylinder(self) -> bool:
9754		return self._Entity.IsFullCylinder
9755
9756	@property
9757	def BucklingMode(self) -> types.ZoneBucklingMode:
9758		return types.ZoneBucklingMode[self._Entity.BucklingMode.ToString()]
9759
9760	@property
9761	def PerformLocalPostbuckling(self) -> bool:
9762		return self._Entity.PerformLocalPostbuckling
9763
9764	@property
9765	def A11Required(self) -> float:
9766		return self._Entity.A11Required
9767
9768	@property
9769	def A22Required(self) -> float:
9770		return self._Entity.A22Required
9771
9772	@property
9773	def A33Required(self) -> float:
9774		return self._Entity.A33Required
9775
9776	@property
9777	def D11Required(self) -> float:
9778		return self._Entity.D11Required
9779
9780	@property
9781	def D22Required(self) -> float:
9782		return self._Entity.D22Required
9783
9784	@property
9785	def D33Required(self) -> float:
9786		return self._Entity.D33Required
9787
9788	@property
9789	def A11Auto(self) -> float:
9790		return self._Entity.A11Auto
9791
9792	@property
9793	def A22Auto(self) -> float:
9794		return self._Entity.A22Auto
9795
9796	@property
9797	def A33Auto(self) -> float:
9798		return self._Entity.A33Auto
9799
9800	@property
9801	def D11Auto(self) -> float:
9802		return self._Entity.D11Auto
9803
9804	@property
9805	def D22Auto(self) -> float:
9806		return self._Entity.D22Auto
9807
9808	@property
9809	def D33Auto(self) -> float:
9810		return self._Entity.D33Auto
9811
9812	@property
9813	def Ey(self) -> float:
9814		return self._Entity.Ey
9815
9816	@property
9817	def Kx(self) -> float:
9818		return self._Entity.Kx
9819
9820	@property
9821	def Ky(self) -> float:
9822		return self._Entity.Ky
9823
9824	@property
9825	def HoneycombCoreAngle(self) -> float:
9826		return self._Entity.HoneycombCoreAngle
9827
9828	@ReferencePlane.setter
9829	def ReferencePlane(self, value: types.ReferencePlanePanel) -> None:
9830		self._Entity.ReferencePlane = _types.ReferencePlanePanel(value.value)
9831
9832	@AddedOffset.setter
9833	def AddedOffset(self, value: float) -> None:
9834		self._Entity.AddedOffset = value
9835
9836	@YSpan.setter
9837	def YSpan(self, value: float) -> None:
9838		self._Entity.YSpan = value
9839
9840	@IsCurved.setter
9841	def IsCurved(self, value: bool) -> None:
9842		self._Entity.IsCurved = value
9843
9844	@Radius.setter
9845	def Radius(self, value: float) -> None:
9846		self._Entity.Radius = value
9847
9848	@IsFullCylinder.setter
9849	def IsFullCylinder(self, value: bool) -> None:
9850		self._Entity.IsFullCylinder = value
9851
9852	@BucklingMode.setter
9853	def BucklingMode(self, value: types.ZoneBucklingMode) -> None:
9854		self._Entity.BucklingMode = _types.ZoneBucklingMode(value.value)
9855
9856	@PerformLocalPostbuckling.setter
9857	def PerformLocalPostbuckling(self, value: bool) -> None:
9858		self._Entity.PerformLocalPostbuckling = value
9859
9860	@A11Required.setter
9861	def A11Required(self, value: float) -> None:
9862		self._Entity.A11Required = value
9863
9864	@A22Required.setter
9865	def A22Required(self, value: float) -> None:
9866		self._Entity.A22Required = value
9867
9868	@A33Required.setter
9869	def A33Required(self, value: float) -> None:
9870		self._Entity.A33Required = value
9871
9872	@D11Required.setter
9873	def D11Required(self, value: float) -> None:
9874		self._Entity.D11Required = value
9875
9876	@D22Required.setter
9877	def D22Required(self, value: float) -> None:
9878		self._Entity.D22Required = value
9879
9880	@D33Required.setter
9881	def D33Required(self, value: float) -> None:
9882		self._Entity.D33Required = value
9883
9884	@Ey.setter
9885	def Ey(self, value: float) -> None:
9886		self._Entity.Ey = value
9887
9888	@Kx.setter
9889	def Kx(self, value: float) -> None:
9890		self._Entity.Kx = value
9891
9892	@Ky.setter
9893	def Ky(self, value: float) -> None:
9894		self._Entity.Ky = value
9895
9896	@HoneycombCoreAngle.setter
9897	def HoneycombCoreAngle(self, value: float) -> None:
9898		self._Entity.HoneycombCoreAngle = value
9899
9900
9901class PanelBulkUpdater(ZoneBulkUpdaterBase):
9902	def __init__(self, panelBulkUpdater: _api.PanelBulkUpdater):
9903		self._Entity = panelBulkUpdater
9904
9905	def GetBulkUpdater(application: Application, items: list[Panel]) -> PanelBulkUpdater:
9906		itemsList = List[_api.Panel]()
9907		if items is not None:
9908			for thing in items:
9909				if thing is not None:
9910					itemsList.Add(thing._Entity)
9911		return PanelBulkUpdater(_api.PanelBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
9912
9913
9914class PanelSegmentBulkUpdater(ZoneBulkUpdaterBase):
9915	def __init__(self, panelSegmentBulkUpdater: _api.PanelSegmentBulkUpdater):
9916		self._Entity = panelSegmentBulkUpdater
9917
9918	def GetBulkUpdater(application: Application, items: list[PanelSegment]) -> PanelSegmentBulkUpdater:
9919		itemsList = List[_api.PanelSegment]()
9920		if items is not None:
9921			for thing in items:
9922				if thing is not None:
9923					itemsList.Add(thing._Entity)
9924		return PanelSegmentBulkUpdater(_api.PanelSegmentBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
9925
9926
9927class ZoneBulkUpdater(ZoneBulkUpdaterBase):
9928	def __init__(self, zoneBulkUpdater: _api.ZoneBulkUpdater):
9929		self._Entity = zoneBulkUpdater
9930
9931	def GetBulkUpdater(application: Application, items: list[Zone]) -> ZoneBulkUpdater:
9932		itemsList = List[_api.Zone]()
9933		if items is not None:
9934			for thing in items:
9935				if thing is not None:
9936					itemsList.Add(thing._Entity)
9937		return ZoneBulkUpdater(_api.ZoneBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
def MakeCSharpIntList(ints: list[int]) -> System.Collections.Generic.List[Int32]:
16def MakeCSharpIntList(ints: list[int]) -> List[int]:
17	intsList = List[int]()
18	if ints is not None:
19		for thing in ints:
20			if thing is not None:
21				intsList.Add(thing)
22	
23	return intsList
class AnalysisResultToReturn(enum.Enum):
25class AnalysisResultToReturn(Enum):
26	'''
27	Used to specify which analysis result to return.
28	'''
29	Limit = 1
30	Ultimate = 2
31	Minimum = 3

Used to specify which analysis result to return.

Inherited Members
enum.Enum
name
value
class CollectionModificationStatus(enum.Enum):
33class CollectionModificationStatus(Enum):
34	'''
35	Indicates whether a collection was manipulated successfully.
36	'''
37	Success = 1
38	DuplicateIdFailure = 2
39	EntityMissingAddFailure = 3
40	EntityMissingRemovalFailure = 4
41	FemConnectionFailure = 5
42	RunSetUsageFailure = 6
43	EntityRemovalDependencyFailure = 7

Indicates whether a collection was manipulated successfully.

EntityRemovalDependencyFailure = <CollectionModificationStatus.EntityRemovalDependencyFailure: 7>
Inherited Members
enum.Enum
name
value
class CreateDatabaseStatus(enum.Enum):
45class CreateDatabaseStatus(Enum):
46	Success = 1
47	TemplateNotFound = 2
48	ImproperExtension = 3
TemplateNotFound = <CreateDatabaseStatus.TemplateNotFound: 2>
ImproperExtension = <CreateDatabaseStatus.ImproperExtension: 3>
Inherited Members
enum.Enum
name
value
class MaterialCreationStatus(enum.Enum):
50class MaterialCreationStatus(Enum):
51	'''
52	Indicates whether a material was created successfully. 
53            If not, this indicates why the material was not created.
54	'''
55	Success = 1
56	DuplicateNameFailure = 2
57	DuplicateFemIdFailure = 3
58	MissingMaterialToCopy = 4

Indicates whether a material was created successfully. If not, this indicates why the material was not created.

DuplicateNameFailure = <MaterialCreationStatus.DuplicateNameFailure: 2>
DuplicateFemIdFailure = <MaterialCreationStatus.DuplicateFemIdFailure: 3>
MissingMaterialToCopy = <MaterialCreationStatus.MissingMaterialToCopy: 4>
Inherited Members
enum.Enum
name
value
class DbForceUnit(enum.Enum):
60class DbForceUnit(Enum):
61	Pounds = 1
62	Newtons = 2
63	Dekanewtons = 4
Pounds = <DbForceUnit.Pounds: 1>
Newtons = <DbForceUnit.Newtons: 2>
Dekanewtons = <DbForceUnit.Dekanewtons: 4>
Inherited Members
enum.Enum
name
value
class DbLengthUnit(enum.Enum):
65class DbLengthUnit(Enum):
66	Inches = 1
67	Feet = 2
68	Meters = 3
69	Centimeters = 4
70	Millimeters = 5
Inches = <DbLengthUnit.Inches: 1>
Feet = <DbLengthUnit.Feet: 2>
Meters = <DbLengthUnit.Meters: 3>
Centimeters = <DbLengthUnit.Centimeters: 4>
Millimeters = <DbLengthUnit.Millimeters: 5>
Inherited Members
enum.Enum
name
value
class DbMassUnit(enum.Enum):
72class DbMassUnit(Enum):
73	Pounds = 1
74	Kilograms = 2
75	Slinches = 4
76	Slugs = 5
77	Megagrams = 6
Pounds = <DbMassUnit.Pounds: 1>
Kilograms = <DbMassUnit.Kilograms: 2>
Slinches = <DbMassUnit.Slinches: 4>
Slugs = <DbMassUnit.Slugs: 5>
Megagrams = <DbMassUnit.Megagrams: 6>
Inherited Members
enum.Enum
name
value
class DbTemperatureUnit(enum.Enum):
79class DbTemperatureUnit(Enum):
80	Fahrenheit = 1
81	Rankine = 2
82	Celsius = 3
83	Kelvin = 4
Fahrenheit = <DbTemperatureUnit.Fahrenheit: 1>
Rankine = <DbTemperatureUnit.Rankine: 2>
Celsius = <DbTemperatureUnit.Celsius: 3>
Kelvin = <DbTemperatureUnit.Kelvin: 4>
Inherited Members
enum.Enum
name
value
class ProjectCreationStatus(enum.Enum):
85class ProjectCreationStatus(Enum):
86	'''
87	Indicates whether a project was created successfully. 
88            If not, this indicates why the project was not created.
89	'''
90	Success = 1
91	Failure = 2
92	DuplicateNameFailure = 3

Indicates whether a project was created successfully. If not, this indicates why the project was not created.

DuplicateNameFailure = <ProjectCreationStatus.DuplicateNameFailure: 3>
Inherited Members
enum.Enum
name
value
class ProjectDeletionStatus(enum.Enum):
 94class ProjectDeletionStatus(Enum):
 95	'''
 96	Indicates whether a project was deleted successfully. 
 97            If not, this indicates why the project was not deleted.
 98	'''
 99	Success = 1
100	Failure = 2
101	ProjectDoesNotExistFailure = 3
102	ActiveProjectFailure = 4

Indicates whether a project was deleted successfully. If not, this indicates why the project was not deleted.

ProjectDoesNotExistFailure = <ProjectDeletionStatus.ProjectDoesNotExistFailure: 3>
ActiveProjectFailure = <ProjectDeletionStatus.ActiveProjectFailure: 4>
Inherited Members
enum.Enum
name
value
class SetUnitsStatus(enum.Enum):
104class SetUnitsStatus(Enum):
105	Success = 1
106	Error = 2
107	MixedUnitSystemError = 3
Success = <SetUnitsStatus.Success: 1>
Error = <SetUnitsStatus.Error: 2>
MixedUnitSystemError = <SetUnitsStatus.MixedUnitSystemError: 3>
Inherited Members
enum.Enum
name
value
class PropertyAssignmentStatus(enum.Enum):
109class PropertyAssignmentStatus(Enum):
110	Success = 1
111	Failure = 2
112	FailureCollectionAssignment = 3
113	PropertyIsNull = 4
114	PropertyNotFoundInDb = 5
115	EmptyCollection = 6
116	IncompatiblePropertyAssignment = 7
117	EntityDoesNotExist = 8
FailureCollectionAssignment = <PropertyAssignmentStatus.FailureCollectionAssignment: 3>
PropertyNotFoundInDb = <PropertyAssignmentStatus.PropertyNotFoundInDb: 5>
IncompatiblePropertyAssignment = <PropertyAssignmentStatus.IncompatiblePropertyAssignment: 7>
Inherited Members
enum.Enum
name
value
class RundeckBulkUpdateStatus(enum.Enum):
119class RundeckBulkUpdateStatus(Enum):
120	NoRundecksUpdated = 0
121	Success = 1
122	InputFilePathDoesNotExist = 2
123	ResultFilePathDoesNotExist = 3
124	InputFilePathAlreadyExists = 4
125	ResultFilePathAlreadyExists = 5
126	InvalidPathCount = 6
127	RundeckBulkUpdateFailure = 7
128	SuccessButIncompatibleFem = 8
InputFilePathDoesNotExist = <RundeckBulkUpdateStatus.InputFilePathDoesNotExist: 2>
ResultFilePathDoesNotExist = <RundeckBulkUpdateStatus.ResultFilePathDoesNotExist: 3>
InputFilePathAlreadyExists = <RundeckBulkUpdateStatus.InputFilePathAlreadyExists: 4>
ResultFilePathAlreadyExists = <RundeckBulkUpdateStatus.ResultFilePathAlreadyExists: 5>
RundeckBulkUpdateFailure = <RundeckBulkUpdateStatus.RundeckBulkUpdateFailure: 7>
SuccessButIncompatibleFem = <RundeckBulkUpdateStatus.SuccessButIncompatibleFem: 8>
Inherited Members
enum.Enum
name
value
class RundeckCreationStatus(enum.Enum):
130class RundeckCreationStatus(Enum):
131	Success = 1
132	InputFilePathAlreadyExists = 2
133	ResultFilePathAlreadyExists = 3
InputFilePathAlreadyExists = <RundeckCreationStatus.InputFilePathAlreadyExists: 2>
ResultFilePathAlreadyExists = <RundeckCreationStatus.ResultFilePathAlreadyExists: 3>
Inherited Members
enum.Enum
name
value
class RundeckRemoveStatus(enum.Enum):
135class RundeckRemoveStatus(Enum):
136	Success = 1
137	InvalidId = 2
138	CannotRemoveLastRundeck = 3
139	CannotDeletePrimaryRundeck = 4
140	RundeckNotFound = 5
141	RundeckRemoveFailure = 6
142	SuccessButIncompatibleFem = 7
CannotRemoveLastRundeck = <RundeckRemoveStatus.CannotRemoveLastRundeck: 3>
CannotDeletePrimaryRundeck = <RundeckRemoveStatus.CannotDeletePrimaryRundeck: 4>
RundeckNotFound = <RundeckRemoveStatus.RundeckNotFound: 5>
RundeckRemoveFailure = <RundeckRemoveStatus.RundeckRemoveFailure: 6>
SuccessButIncompatibleFem = <RundeckRemoveStatus.SuccessButIncompatibleFem: 7>
Inherited Members
enum.Enum
name
value
class RundeckUpdateStatus(enum.Enum):
144class RundeckUpdateStatus(Enum):
145	Success = 1
146	InvalidId = 2
147	IdDoesNotExist = 3
148	RundeckAlreadyPrimary = 4
149	InputPathInUse = 5
150	ResultPathInUse = 6
151	RundeckCommitFailure = 7
152	InputPathDoesNotExist = 8
153	ResultPathDoesNotExist = 9
154	SuccessButIncompatibleFem = 10
IdDoesNotExist = <RundeckUpdateStatus.IdDoesNotExist: 3>
RundeckAlreadyPrimary = <RundeckUpdateStatus.RundeckAlreadyPrimary: 4>
InputPathInUse = <RundeckUpdateStatus.InputPathInUse: 5>
ResultPathInUse = <RundeckUpdateStatus.ResultPathInUse: 6>
RundeckCommitFailure = <RundeckUpdateStatus.RundeckCommitFailure: 7>
InputPathDoesNotExist = <RundeckUpdateStatus.InputPathDoesNotExist: 8>
ResultPathDoesNotExist = <RundeckUpdateStatus.ResultPathDoesNotExist: 9>
SuccessButIncompatibleFem = <RundeckUpdateStatus.SuccessButIncompatibleFem: 10>
Inherited Members
enum.Enum
name
value
class ZoneCreationStatus(enum.Enum):
156class ZoneCreationStatus(Enum):
157	'''
158	Indicates whether a zone was created successfully. 
159            If not, this indicates why the zone was not created.
160	'''
161	Success = 1
162	DuplicateNameFailure = 2
163	InvalidFamilyCategory = 3

Indicates whether a zone was created successfully. If not, this indicates why the zone was not created.

DuplicateNameFailure = <ZoneCreationStatus.DuplicateNameFailure: 2>
InvalidFamilyCategory = <ZoneCreationStatus.InvalidFamilyCategory: 3>
Inherited Members
enum.Enum
name
value
class ZoneIdUpdateStatus(enum.Enum):
165class ZoneIdUpdateStatus(Enum):
166	Success = 1
167	DuplicateIdFailure = 2
168	IdOutOfRangeError = 3
DuplicateIdFailure = <ZoneIdUpdateStatus.DuplicateIdFailure: 2>
IdOutOfRangeError = <ZoneIdUpdateStatus.IdOutOfRangeError: 3>
Inherited Members
enum.Enum
name
value
class UnitSystem(enum.Enum):
170class UnitSystem(Enum):
171	'''
172	Unit system specified when starting a scripting Application.
173	'''
174	English = 1
175	SI = 2

Unit system specified when starting a scripting Application.

English = <UnitSystem.English: 1>
SI = <UnitSystem.SI: 2>
Inherited Members
enum.Enum
name
value
class IdEntity(abc.ABC):
177class IdEntity(ABC):
178	'''
179	Represents an entity with an ID.
180	'''
181	def __init__(self, idEntity: _api.IdEntity):
182		self._Entity = idEntity
183
184	@property
185	def Id(self) -> int:
186		return self._Entity.Id

Represents an entity with an ID.

IdEntity(idEntity: HyperX.Scripting.IdEntity)
181	def __init__(self, idEntity: _api.IdEntity):
182		self._Entity = idEntity
Id: int
184	@property
185	def Id(self) -> int:
186		return self._Entity.Id
class IdNameEntity(IdEntity):
189class IdNameEntity(IdEntity):
190	'''
191	Represents an entity with an ID and Name.
192	'''
193	def __init__(self, idNameEntity: _api.IdNameEntity):
194		self._Entity = idNameEntity
195
196	@property
197	def Name(self) -> str:
198		return self._Entity.Name

Represents an entity with an ID and Name.

IdNameEntity(idNameEntity: HyperX.Scripting.IdNameEntity)
193	def __init__(self, idNameEntity: _api.IdNameEntity):
194		self._Entity = idNameEntity
Name: str
196	@property
197	def Name(self) -> str:
198		return self._Entity.Name
Inherited Members
IdEntity
Id
class AnalysisDefinition(IdNameEntity):
200class AnalysisDefinition(IdNameEntity):
201	def __init__(self, analysisDefinition: _api.AnalysisDefinition):
202		self._Entity = analysisDefinition
203
204	@property
205	def AnalysisId(self) -> int:
206		return self._Entity.AnalysisId
207
208	@property
209	def Description(self) -> str:
210		return self._Entity.Description

Represents an entity with an ID and Name.

AnalysisDefinition(analysisDefinition: HyperX.Scripting.AnalysisDefinition)
201	def __init__(self, analysisDefinition: _api.AnalysisDefinition):
202		self._Entity = analysisDefinition
AnalysisId: int
204	@property
205	def AnalysisId(self) -> int:
206		return self._Entity.AnalysisId
Description: str
208	@property
209	def Description(self) -> str:
210		return self._Entity.Description
Inherited Members
IdNameEntity
Name
IdEntity
Id
class Margin:
213class Margin:
214	'''
215	Represents a Margin result.
216	'''
217	def __init__(self, margin: _api.Margin):
218		self._Entity = margin
219
220	@property
221	def AdjustedMargin(self) -> float:
222		return self._Entity.AdjustedMargin
223
224	@property
225	def IsFailureCode(self) -> bool:
226		return self._Entity.IsFailureCode
227
228	@property
229	def IsInformationalCode(self) -> bool:
230		return self._Entity.IsInformationalCode
231
232	@property
233	def MarginCode(self) -> types.MarginCode:
234		return types.MarginCode[self._Entity.MarginCode.ToString()]

Represents a Margin result.

Margin(margin: HyperX.Scripting.Margin)
217	def __init__(self, margin: _api.Margin):
218		self._Entity = margin
AdjustedMargin: float
220	@property
221	def AdjustedMargin(self) -> float:
222		return self._Entity.AdjustedMargin
IsFailureCode: bool
224	@property
225	def IsFailureCode(self) -> bool:
226		return self._Entity.IsFailureCode
IsInformationalCode: bool
228	@property
229	def IsInformationalCode(self) -> bool:
230		return self._Entity.IsInformationalCode
MarginCode: hyperx.api.types.MarginCode
232	@property
233	def MarginCode(self) -> types.MarginCode:
234		return types.MarginCode[self._Entity.MarginCode.ToString()]
class AnalysisResult(abc.ABC):
237class AnalysisResult(ABC):
238	'''
239	Contains result information for an analysis
240	'''
241	def __init__(self, analysisResult: _api.AnalysisResult):
242		self._Entity = analysisResult
243
244	@property
245	def LimitUltimate(self) -> types.LimitUltimate:
246		'''
247		Limit vs Ultimate loads.
248		'''
249		return types.LimitUltimate[self._Entity.LimitUltimate.ToString()]
250
251	@property
252	def LoadCaseId(self) -> int:
253		return self._Entity.LoadCaseId
254
255	@property
256	def Margin(self) -> Margin:
257		'''
258		Represents a Margin result.
259		'''
260		result = self._Entity.Margin
261		return Margin(result) if result is not None else None
262
263	@property
264	def AnalysisDefinition(self) -> AnalysisDefinition:
265		result = self._Entity.AnalysisDefinition
266		return AnalysisDefinition(result) if result is not None else None

Contains result information for an analysis

AnalysisResult(analysisResult: HyperX.Scripting.AnalysisResult)
241	def __init__(self, analysisResult: _api.AnalysisResult):
242		self._Entity = analysisResult
LimitUltimate: hyperx.api.types.LimitUltimate
244	@property
245	def LimitUltimate(self) -> types.LimitUltimate:
246		'''
247		Limit vs Ultimate loads.
248		'''
249		return types.LimitUltimate[self._Entity.LimitUltimate.ToString()]

Limit vs Ultimate loads.

LoadCaseId: int
251	@property
252	def LoadCaseId(self) -> int:
253		return self._Entity.LoadCaseId
Margin: <property object at 0x000001C374B009F0>
255	@property
256	def Margin(self) -> Margin:
257		'''
258		Represents a Margin result.
259		'''
260		result = self._Entity.Margin
261		return Margin(result) if result is not None else None

Represents a Margin result.

AnalysisDefinition: <property object at 0x000001C374B00A40>
263	@property
264	def AnalysisDefinition(self) -> AnalysisDefinition:
265		result = self._Entity.AnalysisDefinition
266		return AnalysisDefinition(result) if result is not None else None
class JointAnalysisResult(AnalysisResult):
269class JointAnalysisResult(AnalysisResult):
270	def __init__(self, jointAnalysisResult: _api.JointAnalysisResult):
271		self._Entity = jointAnalysisResult
272
273	@property
274	def ObjectId(self) -> types.JointObject:
275		'''
276		Enum identifying the possible entities within a joint
277		'''
278		return types.JointObject[self._Entity.ObjectId.ToString()]

Contains result information for an analysis

JointAnalysisResult(jointAnalysisResult: HyperX.Scripting.JointAnalysisResult)
270	def __init__(self, jointAnalysisResult: _api.JointAnalysisResult):
271		self._Entity = jointAnalysisResult
ObjectId: hyperx.api.types.JointObject
273	@property
274	def ObjectId(self) -> types.JointObject:
275		'''
276		Enum identifying the possible entities within a joint
277		'''
278		return types.JointObject[self._Entity.ObjectId.ToString()]

Enum identifying the possible entities within a joint

class ZoneAnalysisConceptResult(AnalysisResult):
281class ZoneAnalysisConceptResult(AnalysisResult):
282	def __init__(self, zoneAnalysisConceptResult: _api.ZoneAnalysisConceptResult):
283		self._Entity = zoneAnalysisConceptResult
284
285	@property
286	def ConceptId(self) -> types.FamilyConceptUID:
287		return types.FamilyConceptUID[self._Entity.ConceptId.ToString()]

Contains result information for an analysis

ZoneAnalysisConceptResult( zoneAnalysisConceptResult: HyperX.Scripting.ZoneAnalysisConceptResult)
282	def __init__(self, zoneAnalysisConceptResult: _api.ZoneAnalysisConceptResult):
283		self._Entity = zoneAnalysisConceptResult
ConceptId: hyperx.api.types.FamilyConceptUID
285	@property
286	def ConceptId(self) -> types.FamilyConceptUID:
287		return types.FamilyConceptUID[self._Entity.ConceptId.ToString()]
class ZoneAnalysisObjectResult(AnalysisResult):
290class ZoneAnalysisObjectResult(AnalysisResult):
291	def __init__(self, zoneAnalysisObjectResult: _api.ZoneAnalysisObjectResult):
292		self._Entity = zoneAnalysisObjectResult
293
294	@property
295	def ObjectId(self) -> types.FamilyObjectUID:
296		return types.FamilyObjectUID[self._Entity.ObjectId.ToString()]

Contains result information for an analysis

ZoneAnalysisObjectResult(zoneAnalysisObjectResult: HyperX.Scripting.ZoneAnalysisObjectResult)
291	def __init__(self, zoneAnalysisObjectResult: _api.ZoneAnalysisObjectResult):
292		self._Entity = zoneAnalysisObjectResult
ObjectId: hyperx.api.types.FamilyObjectUID
294	@property
295	def ObjectId(self) -> types.FamilyObjectUID:
296		return types.FamilyObjectUID[self._Entity.ObjectId.ToString()]
class AssignableProperty(IdNameEntity):
299class AssignableProperty(IdNameEntity):
300	def __init__(self, assignableProperty: _api.AssignableProperty):
301		self._Entity = assignableProperty

Represents an entity with an ID and Name.

AssignableProperty(assignableProperty: HyperX.Scripting.AssignableProperty)
300	def __init__(self, assignableProperty: _api.AssignableProperty):
301		self._Entity = assignableProperty
Inherited Members
IdNameEntity
Name
IdEntity
Id
class AssignablePropertyWithFamilyCategory(AssignableProperty):
304class AssignablePropertyWithFamilyCategory(AssignableProperty):
305	def __init__(self, assignablePropertyWithFamilyCategory: _api.AssignablePropertyWithFamilyCategory):
306		self._Entity = assignablePropertyWithFamilyCategory
307
308	@property
309	def FamilyCategory(self) -> types.FamilyCategory:
310		return types.FamilyCategory[self._Entity.FamilyCategory.ToString()]

Represents an entity with an ID and Name.

AssignablePropertyWithFamilyCategory( assignablePropertyWithFamilyCategory: HyperX.Scripting.AssignablePropertyWithFamilyCategory)
305	def __init__(self, assignablePropertyWithFamilyCategory: _api.AssignablePropertyWithFamilyCategory):
306		self._Entity = assignablePropertyWithFamilyCategory
FamilyCategory: hyperx.api.types.FamilyCategory
308	@property
309	def FamilyCategory(self) -> types.FamilyCategory:
310		return types.FamilyCategory[self._Entity.FamilyCategory.ToString()]
Inherited Members
IdNameEntity
Name
IdEntity
Id
class FailureObjectGroup(IdNameEntity):
313class FailureObjectGroup(IdNameEntity):
314	def __init__(self, failureObjectGroup: _api.FailureObjectGroup):
315		self._Entity = failureObjectGroup
316
317	@property
318	def ObjectGroup(self) -> types.ObjectGroup:
319		return types.ObjectGroup[self._Entity.ObjectGroup.ToString()]
320
321	@property
322	def IsEnabled(self) -> bool:
323		return self._Entity.IsEnabled
324
325	@property
326	def LimitUltimate(self) -> types.LimitUltimate:
327		'''
328		Limit vs Ultimate loads.
329		'''
330		return types.LimitUltimate[self._Entity.LimitUltimate.ToString()]
331
332	@property
333	def RequiredMargin(self) -> float:
334		return self._Entity.RequiredMargin
335
336	@IsEnabled.setter
337	def IsEnabled(self, value: bool) -> None:
338		self._Entity.IsEnabled = value
339
340	@LimitUltimate.setter
341	def LimitUltimate(self, value: types.LimitUltimate) -> None:
342		self._Entity.LimitUltimate = _types.LimitUltimate(value.value)
343
344	@RequiredMargin.setter
345	def RequiredMargin(self, value: float) -> None:
346		self._Entity.RequiredMargin = value

Represents an entity with an ID and Name.

FailureObjectGroup(failureObjectGroup: HyperX.Scripting.FailureObjectGroup)
314	def __init__(self, failureObjectGroup: _api.FailureObjectGroup):
315		self._Entity = failureObjectGroup
ObjectGroup: hyperx.api.types.ObjectGroup
317	@property
318	def ObjectGroup(self) -> types.ObjectGroup:
319		return types.ObjectGroup[self._Entity.ObjectGroup.ToString()]
IsEnabled: bool
321	@property
322	def IsEnabled(self) -> bool:
323		return self._Entity.IsEnabled
LimitUltimate: hyperx.api.types.LimitUltimate
325	@property
326	def LimitUltimate(self) -> types.LimitUltimate:
327		'''
328		Limit vs Ultimate loads.
329		'''
330		return types.LimitUltimate[self._Entity.LimitUltimate.ToString()]

Limit vs Ultimate loads.

RequiredMargin: float
332	@property
333	def RequiredMargin(self) -> float:
334		return self._Entity.RequiredMargin
Inherited Members
IdNameEntity
Name
IdEntity
Id
class FailureSetting(IdNameEntity):
349class FailureSetting(IdNameEntity):
350	'''
351	Setting for a Failure Mode or a Failure Criteria.
352	'''
353	def __init__(self, failureSetting: _api.FailureSetting):
354		self._Entity = failureSetting
355
356	@property
357	def CategoryId(self) -> int:
358		return self._Entity.CategoryId
359
360	@property
361	def DataType(self) -> types.UserConstantDataType:
362		return types.UserConstantDataType[self._Entity.DataType.ToString()]
363
364	@property
365	def DefaultValue(self) -> str:
366		return self._Entity.DefaultValue
367
368	@property
369	def Description(self) -> str:
370		return self._Entity.Description
371
372	@property
373	def EnumValues(self) -> dict[int, str]:
374		enumValuesDict = {}
375		for kvp in self._Entity.EnumValues:
376			enumValuesDict[int(kvp.Key)] = str(kvp.Value)
377
378		return enumValuesDict
379
380	@property
381	def PackageId(self) -> int:
382		return self._Entity.PackageId
383
384	@property
385	def PackageSettingId(self) -> int:
386		return self._Entity.PackageSettingId
387
388	@property
389	def UID(self) -> Guid:
390		return self._Entity.UID
391
392	@property
393	def Value(self) -> str:
394		return self._Entity.Value
395
396	def SetStringValue(self, value: str) -> None:
397		return self._Entity.SetStringValue(value)
398
399	def SetIntValue(self, value: int) -> None:
400		return self._Entity.SetIntValue(value)
401
402	def SetFloatValue(self, value: float) -> None:
403		return self._Entity.SetFloatValue(value)
404
405	def SetBoolValue(self, value: bool) -> None:
406		return self._Entity.SetBoolValue(value)
407
408	def SetSelectionValue(self, index: int) -> None:
409		return self._Entity.SetSelectionValue(index)

Setting for a Failure Mode or a Failure Criteria.

FailureSetting(failureSetting: HyperX.Scripting.FailureSetting)
353	def __init__(self, failureSetting: _api.FailureSetting):
354		self._Entity = failureSetting
CategoryId: int
356	@property
357	def CategoryId(self) -> int:
358		return self._Entity.CategoryId
360	@property
361	def DataType(self) -> types.UserConstantDataType:
362		return types.UserConstantDataType[self._Entity.DataType.ToString()]
DefaultValue: str
364	@property
365	def DefaultValue(self) -> str:
366		return self._Entity.DefaultValue
Description: str
368	@property
369	def Description(self) -> str:
370		return self._Entity.Description
EnumValues: dict[int, str]
372	@property
373	def EnumValues(self) -> dict[int, str]:
374		enumValuesDict = {}
375		for kvp in self._Entity.EnumValues:
376			enumValuesDict[int(kvp.Key)] = str(kvp.Value)
377
378		return enumValuesDict
PackageId: int
380	@property
381	def PackageId(self) -> int:
382		return self._Entity.PackageId
PackageSettingId: int
384	@property
385	def PackageSettingId(self) -> int:
386		return self._Entity.PackageSettingId
UID: System.Guid
388	@property
389	def UID(self) -> Guid:
390		return self._Entity.UID
Value: str
392	@property
393	def Value(self) -> str:
394		return self._Entity.Value
def SetStringValue(self, value: str) -> None:
396	def SetStringValue(self, value: str) -> None:
397		return self._Entity.SetStringValue(value)
def SetIntValue(self, value: int) -> None:
399	def SetIntValue(self, value: int) -> None:
400		return self._Entity.SetIntValue(value)
def SetFloatValue(self, value: float) -> None:
402	def SetFloatValue(self, value: float) -> None:
403		return self._Entity.SetFloatValue(value)
def SetBoolValue(self, value: bool) -> None:
405	def SetBoolValue(self, value: bool) -> None:
406		return self._Entity.SetBoolValue(value)
def SetSelectionValue(self, index: int) -> None:
408	def SetSelectionValue(self, index: int) -> None:
409		return self._Entity.SetSelectionValue(index)
Inherited Members
IdNameEntity
Name
IdEntity
Id
class IdEntityCol(typing.Generic[~T], abc.ABC):
412class IdEntityCol(Generic[T], ABC):
413	def __init__(self, idEntityCol: _api.IdEntityCol):
414		self._Entity = idEntityCol
415
416	@property
417	def IdEntityColList(self) -> tuple[IdEntity]:
418		if self._Entity.Count() <= 0:
419			return ()
420		thisClass = type(self._Entity._items[0]).__name__
421		givenClass = IdEntity
422		for subclass in IdEntity.__subclasses__():
423			if subclass.__name__ == thisClass:
424				givenClass = subclass
425		return tuple([givenClass(idEntityCol) for idEntityCol in self._Entity])
426
427	@property
428	def Ids(self) -> tuple[int]:
429		return tuple([int(int32) for int32 in self._Entity.Ids])
430
431	def Contains(self, id: int) -> bool:
432		return self._Entity.Contains(id)
433
434	def Count(self) -> int:
435		return self._Entity.Count()
436
437	def Get(self, id: int) -> T:
438		return self._Entity.Get(id)
439
440	def __getitem__(self, index: int):
441		return self.IdEntityColList[index]
442
443	def __iter__(self):
444		yield from self.IdEntityColList
445
446	def __len__(self):
447		return len(self.IdEntityColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

IdEntityCol(idEntityCol: HyperX.Scripting.IdEntityCol[])
413	def __init__(self, idEntityCol: _api.IdEntityCol):
414		self._Entity = idEntityCol
IdEntityColList: tuple[IdEntity]
416	@property
417	def IdEntityColList(self) -> tuple[IdEntity]:
418		if self._Entity.Count() <= 0:
419			return ()
420		thisClass = type(self._Entity._items[0]).__name__
421		givenClass = IdEntity
422		for subclass in IdEntity.__subclasses__():
423			if subclass.__name__ == thisClass:
424				givenClass = subclass
425		return tuple([givenClass(idEntityCol) for idEntityCol in self._Entity])
Ids: tuple[int]
427	@property
428	def Ids(self) -> tuple[int]:
429		return tuple([int(int32) for int32 in self._Entity.Ids])
def Contains(self, id: int) -> bool:
431	def Contains(self, id: int) -> bool:
432		return self._Entity.Contains(id)
def Count(self) -> int:
434	def Count(self) -> int:
435		return self._Entity.Count()
def Get(self, id: int) -> ~T:
437	def Get(self, id: int) -> T:
438		return self._Entity.Get(id)
class IdNameEntityCol(IdEntityCol, typing.Generic[~T]):
450class IdNameEntityCol(IdEntityCol, Generic[T]):
451	def __init__(self, idNameEntityCol: _api.IdNameEntityCol):
452		self._Entity = idNameEntityCol
453		self._CollectedClass = T
454
455	@property
456	def IdNameEntityColList(self) -> tuple[T]:
457		if self._Entity.Count() <= 0:
458			return ()
459		thisClass = type(self._Entity._items[0]).__name__
460		givenClass = T
461		for subclass in T.__subclasses__():
462			if subclass.__name__ == thisClass:
463				givenClass = subclass
464		return tuple([givenClass(idNameEntityCol) for idNameEntityCol in self._Entity])
465
466	@property
467	def Names(self) -> tuple[str]:
468		return tuple([str(string) for string in self._Entity.Names])
469
470	@overload
471	def Get(self, name: str) -> T: ...
472
473	@overload
474	def Get(self, id: int) -> T: ...
475
476	def Get(self, item1 = None) -> T:
477		if isinstance(item1, str):
478			return self._Entity.Get(item1)
479
480		if isinstance(item1, int):
481			return super().Get(item1)
482
483		return self._Entity.Get(item1)
484
485	def __getitem__(self, index: int):
486		return self.IdNameEntityColList[index]
487
488	def __iter__(self):
489		yield from self.IdNameEntityColList
490
491	def __len__(self):
492		return len(self.IdNameEntityColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

IdNameEntityColList: tuple[~T]
455	@property
456	def IdNameEntityColList(self) -> tuple[T]:
457		if self._Entity.Count() <= 0:
458			return ()
459		thisClass = type(self._Entity._items[0]).__name__
460		givenClass = T
461		for subclass in T.__subclasses__():
462			if subclass.__name__ == thisClass:
463				givenClass = subclass
464		return tuple([givenClass(idNameEntityCol) for idNameEntityCol in self._Entity])
Names: tuple[str]
466	@property
467	def Names(self) -> tuple[str]:
468		return tuple([str(string) for string in self._Entity.Names])
class FailureObjectGroupCol(hyperx.api.IdNameEntityCol[hyperx.api.FailureObjectGroup]):
495class FailureObjectGroupCol(IdNameEntityCol[FailureObjectGroup]):
496	def __init__(self, failureObjectGroupCol: _api.FailureObjectGroupCol):
497		self._Entity = failureObjectGroupCol
498		self._CollectedClass = FailureObjectGroup
499
500	@property
501	def FailureObjectGroupColList(self) -> tuple[FailureObjectGroup]:
502		return tuple([FailureObjectGroup(failureObjectGroupCol) for failureObjectGroupCol in self._Entity])
503
504	@overload
505	def Get(self, objectGroup: types.ObjectGroup) -> FailureObjectGroup: ...
506
507	@overload
508	def Get(self, name: str) -> FailureObjectGroup: ...
509
510	@overload
511	def Get(self, id: int) -> FailureObjectGroup: ...
512
513	def Get(self, item1 = None) -> FailureObjectGroup:
514		if isinstance(item1, types.ObjectGroup):
515			return FailureObjectGroup(self._Entity.Get(_types.ObjectGroup(item1.value)))
516
517		if isinstance(item1, str):
518			return FailureObjectGroup(super().Get(item1))
519
520		if isinstance(item1, int):
521			return FailureObjectGroup(super().Get(item1))
522
523		return FailureObjectGroup(self._Entity.Get(_types.ObjectGroup(item1.value)))
524
525	def __getitem__(self, index: int):
526		return self.FailureObjectGroupColList[index]
527
528	def __iter__(self):
529		yield from self.FailureObjectGroupColList
530
531	def __len__(self):
532		return len(self.FailureObjectGroupColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

FailureObjectGroupCol(failureObjectGroupCol: HyperX.Scripting.FailureObjectGroupCol)
496	def __init__(self, failureObjectGroupCol: _api.FailureObjectGroupCol):
497		self._Entity = failureObjectGroupCol
498		self._CollectedClass = FailureObjectGroup
FailureObjectGroupColList: tuple[FailureObjectGroup]
500	@property
501	def FailureObjectGroupColList(self) -> tuple[FailureObjectGroup]:
502		return tuple([FailureObjectGroup(failureObjectGroupCol) for failureObjectGroupCol in self._Entity])
def Get(self, item1=None) -> FailureObjectGroup:
513	def Get(self, item1 = None) -> FailureObjectGroup:
514		if isinstance(item1, types.ObjectGroup):
515			return FailureObjectGroup(self._Entity.Get(_types.ObjectGroup(item1.value)))
516
517		if isinstance(item1, str):
518			return FailureObjectGroup(super().Get(item1))
519
520		if isinstance(item1, int):
521			return FailureObjectGroup(super().Get(item1))
522
523		return FailureObjectGroup(self._Entity.Get(_types.ObjectGroup(item1.value)))
class FailureSettingCol(hyperx.api.IdNameEntityCol[hyperx.api.FailureSetting]):
535class FailureSettingCol(IdNameEntityCol[FailureSetting]):
536	def __init__(self, failureSettingCol: _api.FailureSettingCol):
537		self._Entity = failureSettingCol
538		self._CollectedClass = FailureSetting
539
540	@property
541	def FailureSettingColList(self) -> tuple[FailureSetting]:
542		return tuple([FailureSetting(failureSettingCol) for failureSettingCol in self._Entity])
543
544	@overload
545	def Get(self, name: str) -> FailureSetting: ...
546
547	@overload
548	def Get(self, id: int) -> FailureSetting: ...
549
550	def Get(self, item1 = None) -> FailureSetting:
551		if isinstance(item1, str):
552			return FailureSetting(super().Get(item1))
553
554		if isinstance(item1, int):
555			return FailureSetting(super().Get(item1))
556
557		result = self._Entity.Get(item1)
558		thisClass = type(result).__name__
559		givenClass = FailureSetting
560		for subclass in FailureSetting.__subclasses__():
561			if subclass.__name__ == thisClass:
562				givenClass = subclass
563		return givenClass(result)
564
565	def __getitem__(self, index: int):
566		return self.FailureSettingColList[index]
567
568	def __iter__(self):
569		yield from self.FailureSettingColList
570
571	def __len__(self):
572		return len(self.FailureSettingColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

FailureSettingCol(failureSettingCol: HyperX.Scripting.FailureSettingCol)
536	def __init__(self, failureSettingCol: _api.FailureSettingCol):
537		self._Entity = failureSettingCol
538		self._CollectedClass = FailureSetting
FailureSettingColList: tuple[FailureSetting]
540	@property
541	def FailureSettingColList(self) -> tuple[FailureSetting]:
542		return tuple([FailureSetting(failureSettingCol) for failureSettingCol in self._Entity])
def Get(self, item1=None) -> FailureSetting:
550	def Get(self, item1 = None) -> FailureSetting:
551		if isinstance(item1, str):
552			return FailureSetting(super().Get(item1))
553
554		if isinstance(item1, int):
555			return FailureSetting(super().Get(item1))
556
557		result = self._Entity.Get(item1)
558		thisClass = type(result).__name__
559		givenClass = FailureSetting
560		for subclass in FailureSetting.__subclasses__():
561			if subclass.__name__ == thisClass:
562				givenClass = subclass
563		return givenClass(result)
class FailureCriterion(IdNameEntity):
575class FailureCriterion(IdNameEntity):
576	def __init__(self, failureCriterion: _api.FailureCriterion):
577		self._Entity = failureCriterion
578
579	@property
580	def Description(self) -> str:
581		return self._Entity.Description
582
583	@property
584	def IsEnabled(self) -> bool:
585		return self._Entity.IsEnabled
586
587	@property
588	def LimitUltimate(self) -> types.LimitUltimate:
589		return types.LimitUltimate[self._Entity.LimitUltimate.ToString()]
590
591	@property
592	def ObjectGroups(self) -> FailureObjectGroupCol:
593		result = self._Entity.ObjectGroups
594		return FailureObjectGroupCol(result) if result is not None else None
595
596	@property
597	def RequiredMargin(self) -> float:
598		return self._Entity.RequiredMargin
599
600	@property
601	def Settings(self) -> FailureSettingCol:
602		result = self._Entity.Settings
603		return FailureSettingCol(result) if result is not None else None
604
605	@IsEnabled.setter
606	def IsEnabled(self, value: bool) -> None:
607		self._Entity.IsEnabled = value
608
609	@LimitUltimate.setter
610	def LimitUltimate(self, value: types.LimitUltimate) -> None:
611		self._Entity.LimitUltimate = _types.LimitUltimate(value.value)
612
613	@RequiredMargin.setter
614	def RequiredMargin(self, value: float) -> None:
615		self._Entity.RequiredMargin = value

Represents an entity with an ID and Name.

FailureCriterion(failureCriterion: HyperX.Scripting.FailureCriterion)
576	def __init__(self, failureCriterion: _api.FailureCriterion):
577		self._Entity = failureCriterion
Description: str
579	@property
580	def Description(self) -> str:
581		return self._Entity.Description
IsEnabled: bool
583	@property
584	def IsEnabled(self) -> bool:
585		return self._Entity.IsEnabled
LimitUltimate: hyperx.api.types.LimitUltimate
587	@property
588	def LimitUltimate(self) -> types.LimitUltimate:
589		return types.LimitUltimate[self._Entity.LimitUltimate.ToString()]
ObjectGroups: FailureObjectGroupCol
591	@property
592	def ObjectGroups(self) -> FailureObjectGroupCol:
593		result = self._Entity.ObjectGroups
594		return FailureObjectGroupCol(result) if result is not None else None
RequiredMargin: float
596	@property
597	def RequiredMargin(self) -> float:
598		return self._Entity.RequiredMargin
Settings: FailureSettingCol
600	@property
601	def Settings(self) -> FailureSettingCol:
602		result = self._Entity.Settings
603		return FailureSettingCol(result) if result is not None else None
Inherited Members
IdNameEntity
Name
IdEntity
Id
class IdNameEntityRenameable(IdNameEntity):
618class IdNameEntityRenameable(IdNameEntity):
619	def __init__(self, idNameEntityRenameable: _api.IdNameEntityRenameable):
620		self._Entity = idNameEntityRenameable
621
622	def Rename(self, name: str) -> None:
623		return self._Entity.Rename(name)

Represents an entity with an ID and Name.

IdNameEntityRenameable(idNameEntityRenameable: HyperX.Scripting.IdNameEntityRenameable)
619	def __init__(self, idNameEntityRenameable: _api.IdNameEntityRenameable):
620		self._Entity = idNameEntityRenameable
def Rename(self, name: str) -> None:
622	def Rename(self, name: str) -> None:
623		return self._Entity.Rename(name)
Inherited Members
IdNameEntity
Name
IdEntity
Id
class FailureCriterionCol(hyperx.api.IdNameEntityCol[hyperx.api.FailureCriterion]):
626class FailureCriterionCol(IdNameEntityCol[FailureCriterion]):
627	def __init__(self, failureCriterionCol: _api.FailureCriterionCol):
628		self._Entity = failureCriterionCol
629		self._CollectedClass = FailureCriterion
630
631	@property
632	def FailureCriterionColList(self) -> tuple[FailureCriterion]:
633		return tuple([FailureCriterion(failureCriterionCol) for failureCriterionCol in self._Entity])
634
635	@overload
636	def Get(self, name: str) -> FailureCriterion: ...
637
638	@overload
639	def Get(self, id: int) -> FailureCriterion: ...
640
641	def Get(self, item1 = None) -> FailureCriterion:
642		if isinstance(item1, str):
643			return FailureCriterion(super().Get(item1))
644
645		if isinstance(item1, int):
646			return FailureCriterion(super().Get(item1))
647
648		return FailureCriterion(self._Entity.Get(item1))
649
650	def __getitem__(self, index: int):
651		return self.FailureCriterionColList[index]
652
653	def __iter__(self):
654		yield from self.FailureCriterionColList
655
656	def __len__(self):
657		return len(self.FailureCriterionColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

FailureCriterionCol(failureCriterionCol: HyperX.Scripting.FailureCriterionCol)
627	def __init__(self, failureCriterionCol: _api.FailureCriterionCol):
628		self._Entity = failureCriterionCol
629		self._CollectedClass = FailureCriterion
FailureCriterionColList: tuple[FailureCriterion]
631	@property
632	def FailureCriterionColList(self) -> tuple[FailureCriterion]:
633		return tuple([FailureCriterion(failureCriterionCol) for failureCriterionCol in self._Entity])
def Get(self, item1=None) -> FailureCriterion:
641	def Get(self, item1 = None) -> FailureCriterion:
642		if isinstance(item1, str):
643			return FailureCriterion(super().Get(item1))
644
645		if isinstance(item1, int):
646			return FailureCriterion(super().Get(item1))
647
648		return FailureCriterion(self._Entity.Get(item1))
class FailureMode(IdNameEntityRenameable):
660class FailureMode(IdNameEntityRenameable):
661	def __init__(self, failureMode: _api.FailureMode):
662		self._Entity = failureMode
663
664	@property
665	def AnalysisCategoryId(self) -> int:
666		return self._Entity.AnalysisCategoryId
667
668	@property
669	def AnalysisCategoryName(self) -> str:
670		return self._Entity.AnalysisCategoryName
671
672	@property
673	def Criteria(self) -> FailureCriterionCol:
674		result = self._Entity.Criteria
675		return FailureCriterionCol(result) if result is not None else None
676
677	@property
678	def Settings(self) -> FailureSettingCol:
679		result = self._Entity.Settings
680		return FailureSettingCol(result) if result is not None else None

Represents an entity with an ID and Name.

FailureMode(failureMode: HyperX.Scripting.FailureMode)
661	def __init__(self, failureMode: _api.FailureMode):
662		self._Entity = failureMode
AnalysisCategoryId: int
664	@property
665	def AnalysisCategoryId(self) -> int:
666		return self._Entity.AnalysisCategoryId
AnalysisCategoryName: str
668	@property
669	def AnalysisCategoryName(self) -> str:
670		return self._Entity.AnalysisCategoryName
Criteria: FailureCriterionCol
672	@property
673	def Criteria(self) -> FailureCriterionCol:
674		result = self._Entity.Criteria
675		return FailureCriterionCol(result) if result is not None else None
Settings: FailureSettingCol
677	@property
678	def Settings(self) -> FailureSettingCol:
679		result = self._Entity.Settings
680		return FailureSettingCol(result) if result is not None else None
class FailureModeCol(hyperx.api.IdNameEntityCol[hyperx.api.FailureMode]):
683class FailureModeCol(IdNameEntityCol[FailureMode]):
684	def __init__(self, failureModeCol: _api.FailureModeCol):
685		self._Entity = failureModeCol
686		self._CollectedClass = FailureMode
687
688	@property
689	def FailureModeColList(self) -> tuple[FailureMode]:
690		return tuple([FailureMode(failureModeCol) for failureModeCol in self._Entity])
691
692	@overload
693	def CreateFailureMode(self, failureModeCategoryId: int, name: str = None) -> FailureMode: ...
694
695	@overload
696	def CreateFailureMode(self, failureModeCategory: str, name: str = None) -> FailureMode: ...
697
698	@overload
699	def Get(self, name: str) -> FailureMode: ...
700
701	@overload
702	def Get(self, id: int) -> FailureMode: ...
703
704	def CreateFailureMode(self, item1 = None, item2 = None) -> FailureMode:
705		if isinstance(item1, int) and isinstance(item2, str):
706			return FailureMode(self._Entity.CreateFailureMode(item1, item2))
707
708		if isinstance(item1, str) and isinstance(item2, str):
709			return FailureMode(self._Entity.CreateFailureMode(item1, item2))
710
711		return FailureMode(self._Entity.CreateFailureMode(item1, item2))
712
713	def Get(self, item1 = None) -> FailureMode:
714		if isinstance(item1, str):
715			return FailureMode(super().Get(item1))
716
717		if isinstance(item1, int):
718			return FailureMode(super().Get(item1))
719
720		return FailureMode(self._Entity.Get(item1))
721
722	def __getitem__(self, index: int):
723		return self.FailureModeColList[index]
724
725	def __iter__(self):
726		yield from self.FailureModeColList
727
728	def __len__(self):
729		return len(self.FailureModeColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

FailureModeCol(failureModeCol: HyperX.Scripting.FailureModeCol)
684	def __init__(self, failureModeCol: _api.FailureModeCol):
685		self._Entity = failureModeCol
686		self._CollectedClass = FailureMode
FailureModeColList: tuple[FailureMode]
688	@property
689	def FailureModeColList(self) -> tuple[FailureMode]:
690		return tuple([FailureMode(failureModeCol) for failureModeCol in self._Entity])
def CreateFailureMode(self, item1=None, item2=None) -> FailureMode:
704	def CreateFailureMode(self, item1 = None, item2 = None) -> FailureMode:
705		if isinstance(item1, int) and isinstance(item2, str):
706			return FailureMode(self._Entity.CreateFailureMode(item1, item2))
707
708		if isinstance(item1, str) and isinstance(item2, str):
709			return FailureMode(self._Entity.CreateFailureMode(item1, item2))
710
711		return FailureMode(self._Entity.CreateFailureMode(item1, item2))
def Get(self, item1=None) -> FailureMode:
713	def Get(self, item1 = None) -> FailureMode:
714		if isinstance(item1, str):
715			return FailureMode(super().Get(item1))
716
717		if isinstance(item1, int):
718			return FailureMode(super().Get(item1))
719
720		return FailureMode(self._Entity.Get(item1))
class AnalysisProperty(AssignablePropertyWithFamilyCategory):
732class AnalysisProperty(AssignablePropertyWithFamilyCategory):
733	def __init__(self, analysisProperty: _api.AnalysisProperty):
734		self._Entity = analysisProperty
735
736	@property
737	def FailureModes(self) -> FailureModeCol:
738		result = self._Entity.FailureModes
739		return FailureModeCol(result) if result is not None else None
740
741	@overload
742	def AddFailureMode(self, id: int) -> None: ...
743
744	@overload
745	def AddFailureMode(self, ids: tuple[int]) -> None: ...
746
747	@overload
748	def RemoveFailureMode(self, id: int) -> None: ...
749
750	@overload
751	def RemoveFailureMode(self, ids: tuple[int]) -> None: ...
752
753	def AddFailureMode(self, item1 = None) -> None:
754		if isinstance(item1, int):
755			return self._Entity.AddFailureMode(item1)
756
757		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
758			idsList = MakeCSharpIntList(item1)
759			idsEnumerable = IEnumerable(idsList)
760			return self._Entity.AddFailureMode(idsEnumerable)
761
762		return self._Entity.AddFailureMode(item1)
763
764	def RemoveFailureMode(self, item1 = None) -> None:
765		if isinstance(item1, int):
766			return self._Entity.RemoveFailureMode(item1)
767
768		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
769			idsList = MakeCSharpIntList(item1)
770			idsEnumerable = IEnumerable(idsList)
771			return self._Entity.RemoveFailureMode(idsEnumerable)
772
773		return self._Entity.RemoveFailureMode(item1)

Represents an entity with an ID and Name.

AnalysisProperty(analysisProperty: HyperX.Scripting.AnalysisProperty)
733	def __init__(self, analysisProperty: _api.AnalysisProperty):
734		self._Entity = analysisProperty
FailureModes: FailureModeCol
736	@property
737	def FailureModes(self) -> FailureModeCol:
738		result = self._Entity.FailureModes
739		return FailureModeCol(result) if result is not None else None
def AddFailureMode(self, item1=None) -> None:
753	def AddFailureMode(self, item1 = None) -> None:
754		if isinstance(item1, int):
755			return self._Entity.AddFailureMode(item1)
756
757		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
758			idsList = MakeCSharpIntList(item1)
759			idsEnumerable = IEnumerable(idsList)
760			return self._Entity.AddFailureMode(idsEnumerable)
761
762		return self._Entity.AddFailureMode(item1)
def RemoveFailureMode(self, item1=None) -> None:
764	def RemoveFailureMode(self, item1 = None) -> None:
765		if isinstance(item1, int):
766			return self._Entity.RemoveFailureMode(item1)
767
768		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
769			idsList = MakeCSharpIntList(item1)
770			idsEnumerable = IEnumerable(idsList)
771			return self._Entity.RemoveFailureMode(idsEnumerable)
772
773		return self._Entity.RemoveFailureMode(item1)
class DesignProperty(AssignablePropertyWithFamilyCategory):
776class DesignProperty(AssignablePropertyWithFamilyCategory):
777	def __init__(self, designProperty: _api.DesignProperty):
778		self._Entity = designProperty
779
780	def Copy(self, newName: str = None) -> DesignProperty:
781		result = self._Entity.Copy(newName)
782		thisClass = type(result).__name__
783		givenClass = DesignProperty
784		for subclass in DesignProperty.__subclasses__():
785			if subclass.__name__ == thisClass:
786				givenClass = subclass
787		return givenClass(result)

Represents an entity with an ID and Name.

DesignProperty(designProperty: HyperX.Scripting.DesignProperty)
777	def __init__(self, designProperty: _api.DesignProperty):
778		self._Entity = designProperty
def Copy(self, newName: str = None) -> DesignProperty:
780	def Copy(self, newName: str = None) -> DesignProperty:
781		result = self._Entity.Copy(newName)
782		thisClass = type(result).__name__
783		givenClass = DesignProperty
784		for subclass in DesignProperty.__subclasses__():
785			if subclass.__name__ == thisClass:
786				givenClass = subclass
787		return givenClass(result)
class LoadProperty(AssignableProperty):
790class LoadProperty(AssignableProperty):
791	def __init__(self, loadProperty: _api.LoadProperty):
792		self._Entity = loadProperty
793
794	@property
795	def Category(self) -> types.FamilyCategory:
796		return types.FamilyCategory[self._Entity.Category.ToString()]
797
798	@property
799	def Type(self) -> types.LoadPropertyType:
800		return types.LoadPropertyType[self._Entity.Type.ToString()]
801
802	@property
803	def IsZeroCurvature(self) -> bool:
804		return self._Entity.IsZeroCurvature
805
806	@property
807	def ModificationDate(self) -> DateTime:
808		return self._Entity.ModificationDate

Represents an entity with an ID and Name.

LoadProperty(loadProperty: HyperX.Scripting.LoadProperty)
791	def __init__(self, loadProperty: _api.LoadProperty):
792		self._Entity = loadProperty
Category: hyperx.api.types.FamilyCategory
794	@property
795	def Category(self) -> types.FamilyCategory:
796		return types.FamilyCategory[self._Entity.Category.ToString()]
798	@property
799	def Type(self) -> types.LoadPropertyType:
800		return types.LoadPropertyType[self._Entity.Type.ToString()]
IsZeroCurvature: bool
802	@property
803	def IsZeroCurvature(self) -> bool:
804		return self._Entity.IsZeroCurvature
ModificationDate: System.DateTime
806	@property
807	def ModificationDate(self) -> DateTime:
808		return self._Entity.ModificationDate
Inherited Members
IdNameEntity
Name
IdEntity
Id
class DesignLoadSubcase(IdNameEntity):
811class DesignLoadSubcase(IdNameEntity):
812	def __init__(self, designLoadSubcase: _api.DesignLoadSubcase):
813		self._Entity = designLoadSubcase
814
815	@property
816	def RunDeckId(self) -> int:
817		return self._Entity.RunDeckId
818
819	@property
820	def IsThermal(self) -> bool:
821		return self._Entity.IsThermal
822
823	@property
824	def IsEditable(self) -> bool:
825		return self._Entity.IsEditable
826
827	@property
828	def Description(self) -> str:
829		return self._Entity.Description
830
831	@property
832	def ModificationDate(self) -> DateTime:
833		return self._Entity.ModificationDate
834
835	@property
836	def NastranSubcaseId(self) -> int:
837		return self._Entity.NastranSubcaseId
838
839	@property
840	def NastranLoadId(self) -> int:
841		return self._Entity.NastranLoadId
842
843	@property
844	def NastranSpcId(self) -> int:
845		return self._Entity.NastranSpcId
846
847	@property
848	def AbaqusStepName(self) -> str:
849		return self._Entity.AbaqusStepName
850
851	@property
852	def AbaqusLoadCaseName(self) -> str:
853		return self._Entity.AbaqusLoadCaseName
854
855	@property
856	def AbaqusStepTime(self) -> float:
857		return self._Entity.AbaqusStepTime
858
859	@property
860	def RunDeckOrder(self) -> int:
861		return self._Entity.RunDeckOrder
862
863	@property
864	def SolutionType(self) -> types.FeaSolutionType:
865		return types.FeaSolutionType[self._Entity.SolutionType.ToString()]

Represents an entity with an ID and Name.

DesignLoadSubcase(designLoadSubcase: HyperX.Scripting.DesignLoadSubcase)
812	def __init__(self, designLoadSubcase: _api.DesignLoadSubcase):
813		self._Entity = designLoadSubcase
RunDeckId: int
815	@property
816	def RunDeckId(self) -> int:
817		return self._Entity.RunDeckId
IsThermal: bool
819	@property
820	def IsThermal(self) -> bool:
821		return self._Entity.IsThermal
IsEditable: bool
823	@property
824	def IsEditable(self) -> bool:
825		return self._Entity.IsEditable
Description: str
827	@property
828	def Description(self) -> str:
829		return self._Entity.Description
ModificationDate: System.DateTime
831	@property
832	def ModificationDate(self) -> DateTime:
833		return self._Entity.ModificationDate
NastranSubcaseId: int
835	@property
836	def NastranSubcaseId(self) -> int:
837		return self._Entity.NastranSubcaseId
NastranLoadId: int
839	@property
840	def NastranLoadId(self) -> int:
841		return self._Entity.NastranLoadId
NastranSpcId: int
843	@property
844	def NastranSpcId(self) -> int:
845		return self._Entity.NastranSpcId
AbaqusStepName: str
847	@property
848	def AbaqusStepName(self) -> str:
849		return self._Entity.AbaqusStepName
AbaqusLoadCaseName: str
851	@property
852	def AbaqusLoadCaseName(self) -> str:
853		return self._Entity.AbaqusLoadCaseName
AbaqusStepTime: float
855	@property
856	def AbaqusStepTime(self) -> float:
857		return self._Entity.AbaqusStepTime
RunDeckOrder: int
859	@property
860	def RunDeckOrder(self) -> int:
861		return self._Entity.RunDeckOrder
SolutionType: hyperx.api.types.FeaSolutionType
863	@property
864	def SolutionType(self) -> types.FeaSolutionType:
865		return types.FeaSolutionType[self._Entity.SolutionType.ToString()]
Inherited Members
IdNameEntity
Name
IdEntity
Id
class DesignLoadSubcaseMultiplier(IdNameEntity):
868class DesignLoadSubcaseMultiplier(IdNameEntity):
869	def __init__(self, designLoadSubcaseMultiplier: _api.DesignLoadSubcaseMultiplier):
870		self._Entity = designLoadSubcaseMultiplier
871
872	@property
873	def LimitFactor(self) -> float:
874		return self._Entity.LimitFactor
875
876	@property
877	def Subcase(self) -> DesignLoadSubcase:
878		result = self._Entity.Subcase
879		return DesignLoadSubcase(result) if result is not None else None
880
881	@property
882	def UltimateFactor(self) -> float:
883		return self._Entity.UltimateFactor
884
885	@property
886	def Value(self) -> float:
887		return self._Entity.Value

Represents an entity with an ID and Name.

DesignLoadSubcaseMultiplier( designLoadSubcaseMultiplier: HyperX.Scripting.DesignLoadSubcaseMultiplier)
869	def __init__(self, designLoadSubcaseMultiplier: _api.DesignLoadSubcaseMultiplier):
870		self._Entity = designLoadSubcaseMultiplier
LimitFactor: float
872	@property
873	def LimitFactor(self) -> float:
874		return self._Entity.LimitFactor
Subcase: DesignLoadSubcase
876	@property
877	def Subcase(self) -> DesignLoadSubcase:
878		result = self._Entity.Subcase
879		return DesignLoadSubcase(result) if result is not None else None
UltimateFactor: float
881	@property
882	def UltimateFactor(self) -> float:
883		return self._Entity.UltimateFactor
Value: float
885	@property
886	def Value(self) -> float:
887		return self._Entity.Value
Inherited Members
IdNameEntity
Name
IdEntity
Id
class DesignLoadSubcaseTemperature(IdNameEntity):
890class DesignLoadSubcaseTemperature(IdNameEntity):
891	def __init__(self, designLoadSubcaseTemperature: _api.DesignLoadSubcaseTemperature):
892		self._Entity = designLoadSubcaseTemperature
893
894	@property
895	def HasTemperatureSubcase(self) -> bool:
896		return self._Entity.HasTemperatureSubcase
897
898	@property
899	def Subcase(self) -> DesignLoadSubcase:
900		result = self._Entity.Subcase
901		return DesignLoadSubcase(result) if result is not None else None
902
903	@property
904	def TemperatureChoiceType(self) -> types.TemperatureChoiceType:
905		'''
906		Load Case Setting selection for analysis and initial temperature.
907		'''
908		return types.TemperatureChoiceType[self._Entity.TemperatureChoiceType.ToString()]
909
910	@property
911	def Value(self) -> float:
912		return self._Entity.Value

Represents an entity with an ID and Name.

DesignLoadSubcaseTemperature( designLoadSubcaseTemperature: HyperX.Scripting.DesignLoadSubcaseTemperature)
891	def __init__(self, designLoadSubcaseTemperature: _api.DesignLoadSubcaseTemperature):
892		self._Entity = designLoadSubcaseTemperature
HasTemperatureSubcase: bool
894	@property
895	def HasTemperatureSubcase(self) -> bool:
896		return self._Entity.HasTemperatureSubcase
Subcase: DesignLoadSubcase
898	@property
899	def Subcase(self) -> DesignLoadSubcase:
900		result = self._Entity.Subcase
901		return DesignLoadSubcase(result) if result is not None else None
TemperatureChoiceType: hyperx.api.types.TemperatureChoiceType
903	@property
904	def TemperatureChoiceType(self) -> types.TemperatureChoiceType:
905		'''
906		Load Case Setting selection for analysis and initial temperature.
907		'''
908		return types.TemperatureChoiceType[self._Entity.TemperatureChoiceType.ToString()]

Load Case Setting selection for analysis and initial temperature.

Value: float
910	@property
911	def Value(self) -> float:
912		return self._Entity.Value
Inherited Members
IdNameEntity
Name
IdEntity
Id
class DesignLoadSubcaseMultiplierCol(hyperx.api.IdNameEntityCol[hyperx.api.DesignLoadSubcaseMultiplier]):
915class DesignLoadSubcaseMultiplierCol(IdNameEntityCol[DesignLoadSubcaseMultiplier]):
916	def __init__(self, designLoadSubcaseMultiplierCol: _api.DesignLoadSubcaseMultiplierCol):
917		self._Entity = designLoadSubcaseMultiplierCol
918		self._CollectedClass = DesignLoadSubcaseMultiplier
919
920	@property
921	def DesignLoadSubcaseMultiplierColList(self) -> tuple[DesignLoadSubcaseMultiplier]:
922		return tuple([DesignLoadSubcaseMultiplier(designLoadSubcaseMultiplierCol) for designLoadSubcaseMultiplierCol in self._Entity])
923
924	@overload
925	def Get(self, name: str) -> DesignLoadSubcaseMultiplier: ...
926
927	@overload
928	def Get(self, id: int) -> DesignLoadSubcaseMultiplier: ...
929
930	def Get(self, item1 = None) -> DesignLoadSubcaseMultiplier:
931		if isinstance(item1, str):
932			return DesignLoadSubcaseMultiplier(super().Get(item1))
933
934		if isinstance(item1, int):
935			return DesignLoadSubcaseMultiplier(super().Get(item1))
936
937		return DesignLoadSubcaseMultiplier(self._Entity.Get(item1))
938
939	def __getitem__(self, index: int):
940		return self.DesignLoadSubcaseMultiplierColList[index]
941
942	def __iter__(self):
943		yield from self.DesignLoadSubcaseMultiplierColList
944
945	def __len__(self):
946		return len(self.DesignLoadSubcaseMultiplierColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

DesignLoadSubcaseMultiplierCol( designLoadSubcaseMultiplierCol: HyperX.Scripting.DesignLoadSubcaseMultiplierCol)
916	def __init__(self, designLoadSubcaseMultiplierCol: _api.DesignLoadSubcaseMultiplierCol):
917		self._Entity = designLoadSubcaseMultiplierCol
918		self._CollectedClass = DesignLoadSubcaseMultiplier
DesignLoadSubcaseMultiplierColList: tuple[DesignLoadSubcaseMultiplier]
920	@property
921	def DesignLoadSubcaseMultiplierColList(self) -> tuple[DesignLoadSubcaseMultiplier]:
922		return tuple([DesignLoadSubcaseMultiplier(designLoadSubcaseMultiplierCol) for designLoadSubcaseMultiplierCol in self._Entity])
def Get(self, item1=None) -> DesignLoadSubcaseMultiplier:
930	def Get(self, item1 = None) -> DesignLoadSubcaseMultiplier:
931		if isinstance(item1, str):
932			return DesignLoadSubcaseMultiplier(super().Get(item1))
933
934		if isinstance(item1, int):
935			return DesignLoadSubcaseMultiplier(super().Get(item1))
936
937		return DesignLoadSubcaseMultiplier(self._Entity.Get(item1))
class DesignLoad(IdNameEntity):
949class DesignLoad(IdNameEntity):
950	def __init__(self, designLoad: _api.DesignLoad):
951		self._Entity = designLoad
952
953	@property
954	def AnalysisTemperature(self) -> DesignLoadSubcaseTemperature:
955		result = self._Entity.AnalysisTemperature
956		return DesignLoadSubcaseTemperature(result) if result is not None else None
957
958	@property
959	def InitialTemperature(self) -> DesignLoadSubcaseTemperature:
960		result = self._Entity.InitialTemperature
961		return DesignLoadSubcaseTemperature(result) if result is not None else None
962
963	@property
964	def Description(self) -> str:
965		return self._Entity.Description
966
967	@property
968	def IsActive(self) -> bool:
969		return self._Entity.IsActive
970
971	@property
972	def IsEditable(self) -> bool:
973		return self._Entity.IsEditable
974
975	@property
976	def IsVirtual(self) -> bool:
977		return self._Entity.IsVirtual
978
979	@property
980	def ModificationDate(self) -> DateTime:
981		return self._Entity.ModificationDate
982
983	@property
984	def SubcaseMultipliers(self) -> DesignLoadSubcaseMultiplierCol:
985		result = self._Entity.SubcaseMultipliers
986		return DesignLoadSubcaseMultiplierCol(result) if result is not None else None
987
988	@property
989	def Types(self) -> list[types.LoadCaseType]:
990		return [types.LoadCaseType[loadCaseType.ToString()] for loadCaseType in self._Entity.Types]
991
992	@property
993	def UID(self) -> Guid:
994		return self._Entity.UID

Represents an entity with an ID and Name.

DesignLoad(designLoad: HyperX.Scripting.DesignLoad)
950	def __init__(self, designLoad: _api.DesignLoad):
951		self._Entity = designLoad
AnalysisTemperature: DesignLoadSubcaseTemperature
953	@property
954	def AnalysisTemperature(self) -> DesignLoadSubcaseTemperature:
955		result = self._Entity.AnalysisTemperature
956		return DesignLoadSubcaseTemperature(result) if result is not None else None
InitialTemperature: DesignLoadSubcaseTemperature
958	@property
959	def InitialTemperature(self) -> DesignLoadSubcaseTemperature:
960		result = self._Entity.InitialTemperature
961		return DesignLoadSubcaseTemperature(result) if result is not None else None
Description: str
963	@property
964	def Description(self) -> str:
965		return self._Entity.Description
IsActive: bool
967	@property
968	def IsActive(self) -> bool:
969		return self._Entity.IsActive
IsEditable: bool
971	@property
972	def IsEditable(self) -> bool:
973		return self._Entity.IsEditable
IsVirtual: bool
975	@property
976	def IsVirtual(self) -> bool:
977		return self._Entity.IsVirtual
ModificationDate: System.DateTime
979	@property
980	def ModificationDate(self) -> DateTime:
981		return self._Entity.ModificationDate
SubcaseMultipliers: DesignLoadSubcaseMultiplierCol
983	@property
984	def SubcaseMultipliers(self) -> DesignLoadSubcaseMultiplierCol:
985		result = self._Entity.SubcaseMultipliers
986		return DesignLoadSubcaseMultiplierCol(result) if result is not None else None
Types: list[hyperx.api.types.LoadCaseType]
988	@property
989	def Types(self) -> list[types.LoadCaseType]:
990		return [types.LoadCaseType[loadCaseType.ToString()] for loadCaseType in self._Entity.Types]
UID: System.Guid
992	@property
993	def UID(self) -> Guid:
994		return self._Entity.UID
Inherited Members
IdNameEntity
Name
IdEntity
Id
class JointDesignResult(IdEntity):
997class JointDesignResult(IdEntity):
998	def __init__(self, jointDesignResult: _api.JointDesignResult):
999		self._Entity = jointDesignResult

Represents an entity with an ID.

JointDesignResult(jointDesignResult: HyperX.Scripting.JointDesignResult)
998	def __init__(self, jointDesignResult: _api.JointDesignResult):
999		self._Entity = jointDesignResult
Inherited Members
IdEntity
Id
class ZoneDesignResult(IdEntity):
1002class ZoneDesignResult(IdEntity):
1003	def __init__(self, zoneDesignResult: _api.ZoneDesignResult):
1004		self._Entity = zoneDesignResult
1005
1006	@property
1007	def VariableParameter(self) -> types.VariableParameter:
1008		return types.VariableParameter[self._Entity.VariableParameter.ToString()]
1009
1010	@property
1011	def Value(self) -> float:
1012		return self._Entity.Value
1013
1014	@property
1015	def MaterialId(self) -> int:
1016		return self._Entity.MaterialId
1017
1018	@property
1019	def MaterialType(self) -> types.MaterialType:
1020		return types.MaterialType[self._Entity.MaterialType.ToString()]

Represents an entity with an ID.

ZoneDesignResult(zoneDesignResult: HyperX.Scripting.ZoneDesignResult)
1003	def __init__(self, zoneDesignResult: _api.ZoneDesignResult):
1004		self._Entity = zoneDesignResult
VariableParameter: hyperx.api.types.VariableParameter
1006	@property
1007	def VariableParameter(self) -> types.VariableParameter:
1008		return types.VariableParameter[self._Entity.VariableParameter.ToString()]
Value: float
1010	@property
1011	def Value(self) -> float:
1012		return self._Entity.Value
MaterialId: int
1014	@property
1015	def MaterialId(self) -> int:
1016		return self._Entity.MaterialId
MaterialType: hyperx.api.types.MaterialType
1018	@property
1019	def MaterialType(self) -> types.MaterialType:
1020		return types.MaterialType[self._Entity.MaterialType.ToString()]
Inherited Members
IdEntity
Id
class Vector3d:
1023class Vector3d:
1024	'''
1025	Represents a readonly 3D vector.
1026	'''
1027	def __init__(self, vector3d: _api.Vector3d):
1028		self._Entity = vector3d
1029
1030	def Create_Vector3d(x: float, y: float, z: float):
1031		return Vector3d(_api.Vector3d(x, y, z))
1032
1033	@property
1034	def X(self) -> float:
1035		return self._Entity.X
1036
1037	@property
1038	def Y(self) -> float:
1039		return self._Entity.Y
1040
1041	@property
1042	def Z(self) -> float:
1043		return self._Entity.Z
1044
1045	@overload
1046	def Equals(self, other) -> bool: ...
1047
1048	@overload
1049	def Equals(self, obj) -> bool: ...
1050
1051	def GetHashCode(self) -> int:
1052		return self._Entity.GetHashCode()
1053
1054	def Equals(self, item1 = None) -> bool:
1055		if isinstance(item1, Vector3d):
1056			return self._Entity.Equals(item1._Entity)
1057
1058		return self._Entity.Equals(item1._Entity)
1059
1060	def __eq__(self, other):
1061		return self.Equals(other)
1062
1063	def __ne__(self, other):
1064		return not self.Equals(other)

Represents a readonly 3D vector.

Vector3d(vector3d: HyperX.Scripting.Vector3d)
1027	def __init__(self, vector3d: _api.Vector3d):
1028		self._Entity = vector3d
def Create_Vector3d(x: float, y: float, z: float):
1030	def Create_Vector3d(x: float, y: float, z: float):
1031		return Vector3d(_api.Vector3d(x, y, z))
X: float
1033	@property
1034	def X(self) -> float:
1035		return self._Entity.X
Y: float
1037	@property
1038	def Y(self) -> float:
1039		return self._Entity.Y
Z: float
1041	@property
1042	def Z(self) -> float:
1043		return self._Entity.Z
def Equals(self, item1=None) -> bool:
1054	def Equals(self, item1 = None) -> bool:
1055		if isinstance(item1, Vector3d):
1056			return self._Entity.Equals(item1._Entity)
1057
1058		return self._Entity.Equals(item1._Entity)
def GetHashCode(self) -> int:
1051	def GetHashCode(self) -> int:
1052		return self._Entity.GetHashCode()
class DiscreteField(IdNameEntityRenameable):
1067class DiscreteField(IdNameEntityRenameable):
1068	'''
1069	Represents a table of discrete field data.
1070	'''
1071	def __init__(self, discreteField: _api.DiscreteField):
1072		self._Entity = discreteField
1073
1074	@property
1075	def Columns(self) -> dict[int, str]:
1076		columnsDict = {}
1077		for kvp in self._Entity.Columns:
1078			columnsDict[int(kvp.Key)] = str(kvp.Value)
1079
1080		return columnsDict
1081
1082	@property
1083	def ColumnCount(self) -> int:
1084		return self._Entity.ColumnCount
1085
1086	@property
1087	def DataType(self) -> types.DiscreteFieldDataType:
1088		'''
1089		Defines the type of data stored in a Discrete Field. Such as Vector, Scalar, String.
1090		'''
1091		return types.DiscreteFieldDataType[self._Entity.DataType.ToString()]
1092
1093	@property
1094	def PhysicalEntityType(self) -> types.DiscreteFieldPhysicalEntityType:
1095		'''
1096		Defines the type of physical entity that a Discrete Field applies to, such as zone, element, joint, etc.
1097		'''
1098		return types.DiscreteFieldPhysicalEntityType[self._Entity.PhysicalEntityType.ToString()]
1099
1100	@property
1101	def PointIds(self) -> list[Vector3d]:
1102		return [Vector3d(vector3d) for vector3d in self._Entity.PointIds]
1103
1104	@property
1105	def RowCount(self) -> int:
1106		return self._Entity.RowCount
1107
1108	@property
1109	def RowIds(self) -> list[int]:
1110		return [int32 for int32 in self._Entity.RowIds]
1111
1112	def AddColumn(self, name: str) -> int:
1113		return self._Entity.AddColumn(name)
1114
1115	def AddPointRow(self, pointId: Vector3d) -> None:
1116		return self._Entity.AddPointRow(pointId._Entity)
1117
1118	@overload
1119	def ReadNumericCell(self, entityId: int, columnId: int) -> float: ...
1120
1121	@overload
1122	def ReadNumericCell(self, pointId: Vector3d, columnId: int) -> float: ...
1123
1124	@overload
1125	def ReadStringCell(self, entityId: int, columnId: int) -> str: ...
1126
1127	@overload
1128	def ReadStringCell(self, pointId: Vector3d, columnId: int) -> str: ...
1129
1130	def SetColumnName(self, columnId: int, name: str) -> None:
1131		return self._Entity.SetColumnName(columnId, name)
1132
1133	@overload
1134	def SetNumericValue(self, entityId: int, columnId: int, value: float) -> None: ...
1135
1136	@overload
1137	def SetNumericValue(self, pointId: Vector3d, columnId: int, value: float) -> None: ...
1138
1139	@overload
1140	def SetStringValue(self, entityId: int, columnId: int, value: str) -> None: ...
1141
1142	@overload
1143	def SetStringValue(self, pointId: Vector3d, columnId: int, value: str) -> None: ...
1144
1145	def DeleteAllRows(self) -> None:
1146		'''
1147		Delete all rows for this discrete field.
1148		'''
1149		return self._Entity.DeleteAllRows()
1150
1151	def DeleteColumn(self, columnId: int) -> None:
1152		return self._Entity.DeleteColumn(columnId)
1153
1154	def DeletePointRow(self, pointId: Vector3d) -> None:
1155		return self._Entity.DeletePointRow(pointId._Entity)
1156
1157	def DeleteRow(self, entityId: int) -> None:
1158		return self._Entity.DeleteRow(entityId)
1159
1160	def DeleteRowsAndColumns(self) -> None:
1161		'''
1162		Delete all rows and columns for this discrete field.
1163		'''
1164		return self._Entity.DeleteRowsAndColumns()
1165
1166	def ReadNumericCell(self, item1 = None, item2 = None) -> float:
1167		if isinstance(item1, int) and isinstance(item2, int):
1168			return self._Entity.ReadNumericCell(item1, item2)
1169
1170		if isinstance(item1, Vector3d) and isinstance(item2, int):
1171			return self._Entity.ReadNumericCell(item1._Entity, item2)
1172
1173		return self._Entity.ReadNumericCell(item1, item2)
1174
1175	def ReadStringCell(self, item1 = None, item2 = None) -> str:
1176		if isinstance(item1, int) and isinstance(item2, int):
1177			return self._Entity.ReadStringCell(item1, item2)
1178
1179		if isinstance(item1, Vector3d) and isinstance(item2, int):
1180			return self._Entity.ReadStringCell(item1._Entity, item2)
1181
1182		return self._Entity.ReadStringCell(item1, item2)
1183
1184	def SetNumericValue(self, item1 = None, item2 = None, item3 = None) -> None:
1185		if isinstance(item1, int) and isinstance(item2, int) and isinstance(item3, float):
1186			return self._Entity.SetNumericValue(item1, item2, item3)
1187
1188		if isinstance(item1, Vector3d) and isinstance(item2, int) and isinstance(item3, float):
1189			return self._Entity.SetNumericValue(item1._Entity, item2, item3)
1190
1191		return self._Entity.SetNumericValue(item1, item2, item3)
1192
1193	def SetStringValue(self, item1 = None, item2 = None, item3 = None) -> None:
1194		if isinstance(item1, int) and isinstance(item2, int) and isinstance(item3, str):
1195			return self._Entity.SetStringValue(item1, item2, item3)
1196
1197		if isinstance(item1, Vector3d) and isinstance(item2, int) and isinstance(item3, str):
1198			return self._Entity.SetStringValue(item1._Entity, item2, item3)
1199
1200		return self._Entity.SetStringValue(item1, item2, item3)

Represents a table of discrete field data.

DiscreteField(discreteField: HyperX.Scripting.DiscreteField)
1071	def __init__(self, discreteField: _api.DiscreteField):
1072		self._Entity = discreteField
Columns: dict[int, str]
1074	@property
1075	def Columns(self) -> dict[int, str]:
1076		columnsDict = {}
1077		for kvp in self._Entity.Columns:
1078			columnsDict[int(kvp.Key)] = str(kvp.Value)
1079
1080		return columnsDict
ColumnCount: int
1082	@property
1083	def ColumnCount(self) -> int:
1084		return self._Entity.ColumnCount
1086	@property
1087	def DataType(self) -> types.DiscreteFieldDataType:
1088		'''
1089		Defines the type of data stored in a Discrete Field. Such as Vector, Scalar, String.
1090		'''
1091		return types.DiscreteFieldDataType[self._Entity.DataType.ToString()]

Defines the type of data stored in a Discrete Field. Such as Vector, Scalar, String.

PhysicalEntityType: hyperx.api.types.DiscreteFieldPhysicalEntityType
1093	@property
1094	def PhysicalEntityType(self) -> types.DiscreteFieldPhysicalEntityType:
1095		'''
1096		Defines the type of physical entity that a Discrete Field applies to, such as zone, element, joint, etc.
1097		'''
1098		return types.DiscreteFieldPhysicalEntityType[self._Entity.PhysicalEntityType.ToString()]

Defines the type of physical entity that a Discrete Field applies to, such as zone, element, joint, etc.

PointIds: list[Vector3d]
1100	@property
1101	def PointIds(self) -> list[Vector3d]:
1102		return [Vector3d(vector3d) for vector3d in self._Entity.PointIds]
RowCount: int
1104	@property
1105	def RowCount(self) -> int:
1106		return self._Entity.RowCount
RowIds: list[int]
1108	@property
1109	def RowIds(self) -> list[int]:
1110		return [int32 for int32 in self._Entity.RowIds]
def AddColumn(self, name: str) -> int:
1112	def AddColumn(self, name: str) -> int:
1113		return self._Entity.AddColumn(name)
def AddPointRow(self, pointId: Vector3d) -> None:
1115	def AddPointRow(self, pointId: Vector3d) -> None:
1116		return self._Entity.AddPointRow(pointId._Entity)
def ReadNumericCell(self, item1=None, item2=None) -> float:
1166	def ReadNumericCell(self, item1 = None, item2 = None) -> float:
1167		if isinstance(item1, int) and isinstance(item2, int):
1168			return self._Entity.ReadNumericCell(item1, item2)
1169
1170		if isinstance(item1, Vector3d) and isinstance(item2, int):
1171			return self._Entity.ReadNumericCell(item1._Entity, item2)
1172
1173		return self._Entity.ReadNumericCell(item1, item2)
def ReadStringCell(self, item1=None, item2=None) -> str:
1175	def ReadStringCell(self, item1 = None, item2 = None) -> str:
1176		if isinstance(item1, int) and isinstance(item2, int):
1177			return self._Entity.ReadStringCell(item1, item2)
1178
1179		if isinstance(item1, Vector3d) and isinstance(item2, int):
1180			return self._Entity.ReadStringCell(item1._Entity, item2)
1181
1182		return self._Entity.ReadStringCell(item1, item2)
def SetColumnName(self, columnId: int, name: str) -> None:
1130	def SetColumnName(self, columnId: int, name: str) -> None:
1131		return self._Entity.SetColumnName(columnId, name)
def SetNumericValue(self, item1=None, item2=None, item3=None) -> None:
1184	def SetNumericValue(self, item1 = None, item2 = None, item3 = None) -> None:
1185		if isinstance(item1, int) and isinstance(item2, int) and isinstance(item3, float):
1186			return self._Entity.SetNumericValue(item1, item2, item3)
1187
1188		if isinstance(item1, Vector3d) and isinstance(item2, int) and isinstance(item3, float):
1189			return self._Entity.SetNumericValue(item1._Entity, item2, item3)
1190
1191		return self._Entity.SetNumericValue(item1, item2, item3)
def SetStringValue(self, item1=None, item2=None, item3=None) -> None:
1193	def SetStringValue(self, item1 = None, item2 = None, item3 = None) -> None:
1194		if isinstance(item1, int) and isinstance(item2, int) and isinstance(item3, str):
1195			return self._Entity.SetStringValue(item1, item2, item3)
1196
1197		if isinstance(item1, Vector3d) and isinstance(item2, int) and isinstance(item3, str):
1198			return self._Entity.SetStringValue(item1._Entity, item2, item3)
1199
1200		return self._Entity.SetStringValue(item1, item2, item3)
def DeleteAllRows(self) -> None:
1145	def DeleteAllRows(self) -> None:
1146		'''
1147		Delete all rows for this discrete field.
1148		'''
1149		return self._Entity.DeleteAllRows()

Delete all rows for this discrete field.

def DeleteColumn(self, columnId: int) -> None:
1151	def DeleteColumn(self, columnId: int) -> None:
1152		return self._Entity.DeleteColumn(columnId)
def DeletePointRow(self, pointId: Vector3d) -> None:
1154	def DeletePointRow(self, pointId: Vector3d) -> None:
1155		return self._Entity.DeletePointRow(pointId._Entity)
def DeleteRow(self, entityId: int) -> None:
1157	def DeleteRow(self, entityId: int) -> None:
1158		return self._Entity.DeleteRow(entityId)
def DeleteRowsAndColumns(self) -> None:
1160	def DeleteRowsAndColumns(self) -> None:
1161		'''
1162		Delete all rows and columns for this discrete field.
1163		'''
1164		return self._Entity.DeleteRowsAndColumns()

Delete all rows and columns for this discrete field.

class Node(IdEntity):
1203class Node(IdEntity):
1204	def __init__(self, node: _api.Node):
1205		self._Entity = node
1206
1207	@property
1208	def X(self) -> float:
1209		return self._Entity.X
1210
1211	@property
1212	def Y(self) -> float:
1213		return self._Entity.Y
1214
1215	@property
1216	def Z(self) -> float:
1217		return self._Entity.Z

Represents an entity with an ID.

Node(node: HyperX.Scripting.Node)
1204	def __init__(self, node: _api.Node):
1205		self._Entity = node
X: float
1207	@property
1208	def X(self) -> float:
1209		return self._Entity.X
Y: float
1211	@property
1212	def Y(self) -> float:
1213		return self._Entity.Y
Z: float
1215	@property
1216	def Z(self) -> float:
1217		return self._Entity.Z
Inherited Members
IdEntity
Id
class Centroid:
1220class Centroid:
1221	def __init__(self, centroid: _api.Centroid):
1222		self._Entity = centroid
1223
1224	@property
1225	def X(self) -> float:
1226		return self._Entity.X
1227
1228	@property
1229	def Y(self) -> float:
1230		return self._Entity.Y
1231
1232	@property
1233	def Z(self) -> float:
1234		return self._Entity.Z
Centroid(centroid: HyperX.Scripting.Centroid)
1221	def __init__(self, centroid: _api.Centroid):
1222		self._Entity = centroid
X: float
1224	@property
1225	def X(self) -> float:
1226		return self._Entity.X
Y: float
1228	@property
1229	def Y(self) -> float:
1230		return self._Entity.Y
Z: float
1232	@property
1233	def Z(self) -> float:
1234		return self._Entity.Z
class Element(IdEntity):
1237class Element(IdEntity):
1238	def __init__(self, element: _api.Element):
1239		self._Entity = element
1240
1241	@property
1242	def MarginOfSafety(self) -> float:
1243		return self._Entity.MarginOfSafety
1244
1245	@property
1246	def Centroid(self) -> Centroid:
1247		result = self._Entity.Centroid
1248		return Centroid(result) if result is not None else None
1249
1250	@property
1251	def Nodes(self) -> list[Node]:
1252		return [Node(node) for node in self._Entity.Nodes]

Represents an entity with an ID.

Element(element: HyperX.Scripting.Element)
1238	def __init__(self, element: _api.Element):
1239		self._Entity = element
MarginOfSafety: float
1241	@property
1242	def MarginOfSafety(self) -> float:
1243		return self._Entity.MarginOfSafety
Centroid: <property object at 0x000001C374B031A0>
1245	@property
1246	def Centroid(self) -> Centroid:
1247		result = self._Entity.Centroid
1248		return Centroid(result) if result is not None else None
Nodes: list[Node]
1250	@property
1251	def Nodes(self) -> list[Node]:
1252		return [Node(node) for node in self._Entity.Nodes]
Inherited Members
IdEntity
Id
class FailureModeCategory(IdNameEntity):
1255class FailureModeCategory(IdNameEntity):
1256	def __init__(self, failureModeCategory: _api.FailureModeCategory):
1257		self._Entity = failureModeCategory
1258
1259	@property
1260	def PackageId(self) -> int:
1261		return self._Entity.PackageId

Represents an entity with an ID and Name.

FailureModeCategory(failureModeCategory: HyperX.Scripting.FailureModeCategory)
1256	def __init__(self, failureModeCategory: _api.FailureModeCategory):
1257		self._Entity = failureModeCategory
PackageId: int
1259	@property
1260	def PackageId(self) -> int:
1261		return self._Entity.PackageId
Inherited Members
IdNameEntity
Name
IdEntity
Id
class EntityWithAssignableProperties(IdNameEntityRenameable):
1264class EntityWithAssignableProperties(IdNameEntityRenameable):
1265	def __init__(self, entityWithAssignableProperties: _api.EntityWithAssignableProperties):
1266		self._Entity = entityWithAssignableProperties
1267
1268	@property
1269	def AssignedAnalysisProperty(self) -> AnalysisProperty:
1270		result = self._Entity.AssignedAnalysisProperty
1271		return AnalysisProperty(result) if result is not None else None
1272
1273	@property
1274	def AssignedDesignProperty(self) -> DesignProperty:
1275		thisClass = type(self._Entity.AssignedDesignProperty).__name__
1276		givenClass = DesignProperty
1277		for subclass in DesignProperty.__subclasses__():
1278			if subclass.__name__ == thisClass:
1279				givenClass = subclass
1280		result = self._Entity.AssignedDesignProperty
1281		return givenClass(result) if result is not None else None
1282
1283	@property
1284	def AssignedLoadProperty(self) -> LoadProperty:
1285		thisClass = type(self._Entity.AssignedLoadProperty).__name__
1286		givenClass = LoadProperty
1287		for subclass in LoadProperty.__subclasses__():
1288			if subclass.__name__ == thisClass:
1289				givenClass = subclass
1290		result = self._Entity.AssignedLoadProperty
1291		return givenClass(result) if result is not None else None
1292
1293	def AssignAnalysisProperty(self, id: int) -> PropertyAssignmentStatus:
1294		return PropertyAssignmentStatus[self._Entity.AssignAnalysisProperty(id).ToString()]
1295
1296	def AssignDesignProperty(self, id: int) -> PropertyAssignmentStatus:
1297		return PropertyAssignmentStatus[self._Entity.AssignDesignProperty(id).ToString()]
1298
1299	def AssignLoadProperty(self, id: int) -> PropertyAssignmentStatus:
1300		return PropertyAssignmentStatus[self._Entity.AssignLoadProperty(id).ToString()]
1301
1302	def AssignProperty(self, property: AssignableProperty) -> PropertyAssignmentStatus:
1303		return PropertyAssignmentStatus[self._Entity.AssignProperty(property._Entity).ToString()]

Represents an entity with an ID and Name.

EntityWithAssignableProperties( entityWithAssignableProperties: HyperX.Scripting.EntityWithAssignableProperties)
1265	def __init__(self, entityWithAssignableProperties: _api.EntityWithAssignableProperties):
1266		self._Entity = entityWithAssignableProperties
AssignedAnalysisProperty: AnalysisProperty
1268	@property
1269	def AssignedAnalysisProperty(self) -> AnalysisProperty:
1270		result = self._Entity.AssignedAnalysisProperty
1271		return AnalysisProperty(result) if result is not None else None
AssignedDesignProperty: DesignProperty
1273	@property
1274	def AssignedDesignProperty(self) -> DesignProperty:
1275		thisClass = type(self._Entity.AssignedDesignProperty).__name__
1276		givenClass = DesignProperty
1277		for subclass in DesignProperty.__subclasses__():
1278			if subclass.__name__ == thisClass:
1279				givenClass = subclass
1280		result = self._Entity.AssignedDesignProperty
1281		return givenClass(result) if result is not None else None
AssignedLoadProperty: LoadProperty
1283	@property
1284	def AssignedLoadProperty(self) -> LoadProperty:
1285		thisClass = type(self._Entity.AssignedLoadProperty).__name__
1286		givenClass = LoadProperty
1287		for subclass in LoadProperty.__subclasses__():
1288			if subclass.__name__ == thisClass:
1289				givenClass = subclass
1290		result = self._Entity.AssignedLoadProperty
1291		return givenClass(result) if result is not None else None
def AssignAnalysisProperty(self, id: int) -> PropertyAssignmentStatus:
1293	def AssignAnalysisProperty(self, id: int) -> PropertyAssignmentStatus:
1294		return PropertyAssignmentStatus[self._Entity.AssignAnalysisProperty(id).ToString()]
def AssignDesignProperty(self, id: int) -> PropertyAssignmentStatus:
1296	def AssignDesignProperty(self, id: int) -> PropertyAssignmentStatus:
1297		return PropertyAssignmentStatus[self._Entity.AssignDesignProperty(id).ToString()]
def AssignLoadProperty(self, id: int) -> PropertyAssignmentStatus:
1299	def AssignLoadProperty(self, id: int) -> PropertyAssignmentStatus:
1300		return PropertyAssignmentStatus[self._Entity.AssignLoadProperty(id).ToString()]
def AssignProperty( self, property: AssignableProperty) -> PropertyAssignmentStatus:
1302	def AssignProperty(self, property: AssignableProperty) -> PropertyAssignmentStatus:
1303		return PropertyAssignmentStatus[self._Entity.AssignProperty(property._Entity).ToString()]
class AnalysisResultCol(typing.Generic[~T]):
1306class AnalysisResultCol(Generic[T]):
1307	def __init__(self, analysisResultCol: _api.AnalysisResultCol):
1308		self._Entity = analysisResultCol
1309
1310	@property
1311	def AnalysisResultColList(self) -> tuple[AnalysisResult]:
1312		if self._Entity.Count() <= 0:
1313			return ()
1314		thisClass = type(self._Entity._items[0]).__name__
1315		givenClass = AnalysisResult
1316		for subclass in AnalysisResult.__subclasses__():
1317			if subclass.__name__ == thisClass:
1318				givenClass = subclass
1319		return tuple([givenClass(analysisResultCol) for analysisResultCol in self._Entity])
1320
1321	def Count(self) -> int:
1322		return self._Entity.Count()
1323
1324	def __getitem__(self, index: int):
1325		return self.AnalysisResultColList[index]
1326
1327	def __iter__(self):
1328		yield from self.AnalysisResultColList
1329
1330	def __len__(self):
1331		return len(self.AnalysisResultColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

AnalysisResultCol(analysisResultCol: HyperX.Scripting.AnalysisResultCol[])
1307	def __init__(self, analysisResultCol: _api.AnalysisResultCol):
1308		self._Entity = analysisResultCol
AnalysisResultColList: tuple[AnalysisResult]
1310	@property
1311	def AnalysisResultColList(self) -> tuple[AnalysisResult]:
1312		if self._Entity.Count() <= 0:
1313			return ()
1314		thisClass = type(self._Entity._items[0]).__name__
1315		givenClass = AnalysisResult
1316		for subclass in AnalysisResult.__subclasses__():
1317			if subclass.__name__ == thisClass:
1318				givenClass = subclass
1319		return tuple([givenClass(analysisResultCol) for analysisResultCol in self._Entity])
def Count(self) -> int:
1321	def Count(self) -> int:
1322		return self._Entity.Count()
class ZoneJointEntity(EntityWithAssignableProperties):
1334class ZoneJointEntity(EntityWithAssignableProperties):
1335	'''
1336	Abstract base for a Zone or Joint.
1337	'''
1338	def __init__(self, zoneJointEntity: _api.ZoneJointEntity):
1339		self._Entity = zoneJointEntity
1340
1341	@abstractmethod
1342	def GetMinimumMargin(self) -> Margin:
1343		return Margin(self._Entity.GetMinimumMargin())
1344
1345	@abstractmethod
1346	def GetControllingResult(self) -> AnalysisResult:
1347		result = self._Entity.GetControllingResult()
1348		thisClass = type(result).__name__
1349		givenClass = AnalysisResult
1350		for subclass in AnalysisResult.__subclasses__():
1351			if subclass.__name__ == thisClass:
1352				givenClass = subclass
1353		return givenClass(result)
1354
1355	@abstractmethod
1356	def GetAllResults(self) -> AnalysisResultCol:
1357		return AnalysisResultCol(self._Entity.GetAllResults())

Abstract base for a Zone or Joint.

@abstractmethod
def GetMinimumMargin(self) -> Margin:
1341	@abstractmethod
1342	def GetMinimumMargin(self) -> Margin:
1343		return Margin(self._Entity.GetMinimumMargin())
@abstractmethod
def GetControllingResult(self) -> AnalysisResult:
1345	@abstractmethod
1346	def GetControllingResult(self) -> AnalysisResult:
1347		result = self._Entity.GetControllingResult()
1348		thisClass = type(result).__name__
1349		givenClass = AnalysisResult
1350		for subclass in AnalysisResult.__subclasses__():
1351			if subclass.__name__ == thisClass:
1352				givenClass = subclass
1353		return givenClass(result)
@abstractmethod
def GetAllResults(self) -> AnalysisResultCol:
1355	@abstractmethod
1356	def GetAllResults(self) -> AnalysisResultCol:
1357		return AnalysisResultCol(self._Entity.GetAllResults())
class JointDesignResultCol(hyperx.api.IdEntityCol[hyperx.api.JointDesignResult]):
1360class JointDesignResultCol(IdEntityCol[JointDesignResult]):
1361	def __init__(self, jointDesignResultCol: _api.JointDesignResultCol):
1362		self._Entity = jointDesignResultCol
1363		self._CollectedClass = JointDesignResult
1364
1365	@property
1366	def JointDesignResultColList(self) -> tuple[JointDesignResult]:
1367		return tuple([JointDesignResult(jointDesignResultCol) for jointDesignResultCol in self._Entity])
1368
1369	@overload
1370	def Get(self, jointSelectionId: types.JointSelectionId) -> JointDesignResult: ...
1371
1372	@overload
1373	def Get(self, jointRangeId: types.JointRangeId) -> JointDesignResult: ...
1374
1375	@overload
1376	def Get(self, id: int) -> JointDesignResult: ...
1377
1378	def Get(self, item1 = None) -> JointDesignResult:
1379		if isinstance(item1, types.JointSelectionId):
1380			result = self._Entity.Get(_types.JointSelectionId(item1.value))
1381			thisClass = type(result).__name__
1382			givenClass = JointDesignResult
1383			for subclass in JointDesignResult.__subclasses__():
1384				if subclass.__name__ == thisClass:
1385					givenClass = subclass
1386			return givenClass(result)
1387
1388		if isinstance(item1, types.JointRangeId):
1389			result = self._Entity.Get(_types.JointRangeId(item1.value))
1390			thisClass = type(result).__name__
1391			givenClass = JointDesignResult
1392			for subclass in JointDesignResult.__subclasses__():
1393				if subclass.__name__ == thisClass:
1394					givenClass = subclass
1395			return givenClass(result)
1396
1397		if isinstance(item1, int):
1398			return JointDesignResult(super().Get(item1))
1399
1400		result = self._Entity.Get(_types.JointSelectionId(item1.value))
1401		thisClass = type(result).__name__
1402		givenClass = JointDesignResult
1403		for subclass in JointDesignResult.__subclasses__():
1404			if subclass.__name__ == thisClass:
1405				givenClass = subclass
1406		return givenClass(result)
1407
1408	def __getitem__(self, index: int):
1409		return self.JointDesignResultColList[index]
1410
1411	def __iter__(self):
1412		yield from self.JointDesignResultColList
1413
1414	def __len__(self):
1415		return len(self.JointDesignResultColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

JointDesignResultCol(jointDesignResultCol: HyperX.Scripting.JointDesignResultCol)
1361	def __init__(self, jointDesignResultCol: _api.JointDesignResultCol):
1362		self._Entity = jointDesignResultCol
1363		self._CollectedClass = JointDesignResult
JointDesignResultColList: tuple[JointDesignResult]
1365	@property
1366	def JointDesignResultColList(self) -> tuple[JointDesignResult]:
1367		return tuple([JointDesignResult(jointDesignResultCol) for jointDesignResultCol in self._Entity])
def Get(self, item1=None) -> JointDesignResult:
1378	def Get(self, item1 = None) -> JointDesignResult:
1379		if isinstance(item1, types.JointSelectionId):
1380			result = self._Entity.Get(_types.JointSelectionId(item1.value))
1381			thisClass = type(result).__name__
1382			givenClass = JointDesignResult
1383			for subclass in JointDesignResult.__subclasses__():
1384				if subclass.__name__ == thisClass:
1385					givenClass = subclass
1386			return givenClass(result)
1387
1388		if isinstance(item1, types.JointRangeId):
1389			result = self._Entity.Get(_types.JointRangeId(item1.value))
1390			thisClass = type(result).__name__
1391			givenClass = JointDesignResult
1392			for subclass in JointDesignResult.__subclasses__():
1393				if subclass.__name__ == thisClass:
1394					givenClass = subclass
1395			return givenClass(result)
1396
1397		if isinstance(item1, int):
1398			return JointDesignResult(super().Get(item1))
1399
1400		result = self._Entity.Get(_types.JointSelectionId(item1.value))
1401		thisClass = type(result).__name__
1402		givenClass = JointDesignResult
1403		for subclass in JointDesignResult.__subclasses__():
1404			if subclass.__name__ == thisClass:
1405				givenClass = subclass
1406		return givenClass(result)
class Joint(ZoneJointEntity):
1418class Joint(ZoneJointEntity):
1419	def __init__(self, joint: _api.Joint):
1420		self._Entity = joint
1421
1422	@property
1423	def JointRangeSizingResults(self) -> JointDesignResultCol:
1424		result = self._Entity.JointRangeSizingResults
1425		return JointDesignResultCol(result) if result is not None else None
1426
1427	@property
1428	def JointSelectionSizingResults(self) -> JointDesignResultCol:
1429		result = self._Entity.JointSelectionSizingResults
1430		return JointDesignResultCol(result) if result is not None else None
1431
1432	def GetAllResults(self) -> AnalysisResultCol:
1433		return AnalysisResultCol(self._Entity.GetAllResults())
1434
1435	def GetControllingResult(self) -> AnalysisResult:
1436		result = self._Entity.GetControllingResult()
1437		thisClass = type(result).__name__
1438		givenClass = AnalysisResult
1439		for subclass in AnalysisResult.__subclasses__():
1440			if subclass.__name__ == thisClass:
1441				givenClass = subclass
1442		return givenClass(result)
1443
1444	def GetMinimumMargin(self) -> Margin:
1445		return Margin(self._Entity.GetMinimumMargin())

Abstract base for a Zone or Joint.

Joint(joint: HyperX.Scripting.Joint)
1419	def __init__(self, joint: _api.Joint):
1420		self._Entity = joint
JointRangeSizingResults: JointDesignResultCol
1422	@property
1423	def JointRangeSizingResults(self) -> JointDesignResultCol:
1424		result = self._Entity.JointRangeSizingResults
1425		return JointDesignResultCol(result) if result is not None else None
JointSelectionSizingResults: JointDesignResultCol
1427	@property
1428	def JointSelectionSizingResults(self) -> JointDesignResultCol:
1429		result = self._Entity.JointSelectionSizingResults
1430		return JointDesignResultCol(result) if result is not None else None
def GetAllResults(self) -> AnalysisResultCol:
1432	def GetAllResults(self) -> AnalysisResultCol:
1433		return AnalysisResultCol(self._Entity.GetAllResults())
def GetControllingResult(self) -> AnalysisResult:
1435	def GetControllingResult(self) -> AnalysisResult:
1436		result = self._Entity.GetControllingResult()
1437		thisClass = type(result).__name__
1438		givenClass = AnalysisResult
1439		for subclass in AnalysisResult.__subclasses__():
1440			if subclass.__name__ == thisClass:
1441				givenClass = subclass
1442		return givenClass(result)
def GetMinimumMargin(self) -> Margin:
1444	def GetMinimumMargin(self) -> Margin:
1445		return Margin(self._Entity.GetMinimumMargin())
class ZoneDesignResultCol(hyperx.api.IdEntityCol[hyperx.api.ZoneDesignResult]):
1448class ZoneDesignResultCol(IdEntityCol[ZoneDesignResult]):
1449	def __init__(self, zoneDesignResultCol: _api.ZoneDesignResultCol):
1450		self._Entity = zoneDesignResultCol
1451		self._CollectedClass = ZoneDesignResult
1452
1453	@property
1454	def ZoneDesignResultColList(self) -> tuple[ZoneDesignResult]:
1455		return tuple([ZoneDesignResult(zoneDesignResultCol) for zoneDesignResultCol in self._Entity])
1456
1457	@overload
1458	def Get(self, parameterId: types.VariableParameter) -> ZoneDesignResult: ...
1459
1460	@overload
1461	def Get(self, id: int) -> ZoneDesignResult: ...
1462
1463	def Get(self, item1 = None) -> ZoneDesignResult:
1464		if isinstance(item1, types.VariableParameter):
1465			return ZoneDesignResult(self._Entity.Get(_types.VariableParameter(item1.value)))
1466
1467		if isinstance(item1, int):
1468			return ZoneDesignResult(super().Get(item1))
1469
1470		return ZoneDesignResult(self._Entity.Get(_types.VariableParameter(item1.value)))
1471
1472	def __getitem__(self, index: int):
1473		return self.ZoneDesignResultColList[index]
1474
1475	def __iter__(self):
1476		yield from self.ZoneDesignResultColList
1477
1478	def __len__(self):
1479		return len(self.ZoneDesignResultColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

ZoneDesignResultCol(zoneDesignResultCol: HyperX.Scripting.ZoneDesignResultCol)
1449	def __init__(self, zoneDesignResultCol: _api.ZoneDesignResultCol):
1450		self._Entity = zoneDesignResultCol
1451		self._CollectedClass = ZoneDesignResult
ZoneDesignResultColList: tuple[ZoneDesignResult]
1453	@property
1454	def ZoneDesignResultColList(self) -> tuple[ZoneDesignResult]:
1455		return tuple([ZoneDesignResult(zoneDesignResultCol) for zoneDesignResultCol in self._Entity])
def Get(self, item1=None) -> ZoneDesignResult:
1463	def Get(self, item1 = None) -> ZoneDesignResult:
1464		if isinstance(item1, types.VariableParameter):
1465			return ZoneDesignResult(self._Entity.Get(_types.VariableParameter(item1.value)))
1466
1467		if isinstance(item1, int):
1468			return ZoneDesignResult(super().Get(item1))
1469
1470		return ZoneDesignResult(self._Entity.Get(_types.VariableParameter(item1.value)))
class ZoneBase(ZoneJointEntity):
1482class ZoneBase(ZoneJointEntity):
1483	'''
1484	Abstract for regular Zones and Panel Segments.
1485	'''
1486	def __init__(self, zoneBase: _api.ZoneBase):
1487		self._Entity = zoneBase
1488
1489	@property
1490	def Centroid(self) -> Centroid:
1491		result = self._Entity.Centroid
1492		return Centroid(result) if result is not None else None
1493
1494	@property
1495	def Id(self) -> int:
1496		return self._Entity.Id
1497
1498	@property
1499	def Weight(self) -> float:
1500		return self._Entity.Weight
1501
1502	@property
1503	def NonOptimumFactor(self) -> float:
1504		return self._Entity.NonOptimumFactor
1505
1506	@property
1507	def AddedWeight(self) -> float:
1508		return self._Entity.AddedWeight
1509
1510	@property
1511	def SuperimposePanel(self) -> bool:
1512		return self._Entity.SuperimposePanel
1513
1514	@property
1515	def BucklingImperfection(self) -> float:
1516		return self._Entity.BucklingImperfection
1517
1518	@property
1519	def IsBeamColumn(self) -> bool:
1520		return self._Entity.IsBeamColumn
1521
1522	@property
1523	def SuperimposeBoundaryCondition(self) -> int:
1524		return self._Entity.SuperimposeBoundaryCondition
1525
1526	@property
1527	def IsZeroOutFeaMoments(self) -> bool:
1528		return self._Entity.IsZeroOutFeaMoments
1529
1530	@property
1531	def IsZeroOutFeaTransverseShears(self) -> bool:
1532		return self._Entity.IsZeroOutFeaTransverseShears
1533
1534	@property
1535	def MechanicalLimit(self) -> float:
1536		return self._Entity.MechanicalLimit
1537
1538	@property
1539	def MechanicalUltimate(self) -> float:
1540		return self._Entity.MechanicalUltimate
1541
1542	@property
1543	def ThermalHelp(self) -> float:
1544		return self._Entity.ThermalHelp
1545
1546	@property
1547	def ThermalHurt(self) -> float:
1548		return self._Entity.ThermalHurt
1549
1550	@property
1551	def FatigueKTSkin(self) -> float:
1552		return self._Entity.FatigueKTSkin
1553
1554	@property
1555	def FatigueKTStiff(self) -> float:
1556		return self._Entity.FatigueKTStiff
1557
1558	@property
1559	def XSpan(self) -> float:
1560		return self._Entity.XSpan
1561
1562	@property
1563	def EARequired(self) -> float:
1564		return self._Entity.EARequired
1565
1566	@property
1567	def EI1Required(self) -> float:
1568		return self._Entity.EI1Required
1569
1570	@property
1571	def EI2Required(self) -> float:
1572		return self._Entity.EI2Required
1573
1574	@property
1575	def GJRequired(self) -> float:
1576		return self._Entity.GJRequired
1577
1578	@property
1579	def EAAuto(self) -> float:
1580		return self._Entity.EAAuto
1581
1582	@property
1583	def EI1Auto(self) -> float:
1584		return self._Entity.EI1Auto
1585
1586	@property
1587	def EI2Auto(self) -> float:
1588		return self._Entity.EI2Auto
1589
1590	@property
1591	def GJAuto(self) -> float:
1592		return self._Entity.GJAuto
1593
1594	@property
1595	def Ex(self) -> float:
1596		return self._Entity.Ex
1597
1598	@property
1599	def Dmid(self) -> float:
1600		return self._Entity.Dmid
1601
1602	@NonOptimumFactor.setter
1603	def NonOptimumFactor(self, value: float) -> None:
1604		self._Entity.NonOptimumFactor = value
1605
1606	@AddedWeight.setter
1607	def AddedWeight(self, value: float) -> None:
1608		self._Entity.AddedWeight = value
1609
1610	@SuperimposePanel.setter
1611	def SuperimposePanel(self, value: bool) -> None:
1612		self._Entity.SuperimposePanel = value
1613
1614	@BucklingImperfection.setter
1615	def BucklingImperfection(self, value: float) -> None:
1616		self._Entity.BucklingImperfection = value
1617
1618	@IsBeamColumn.setter
1619	def IsBeamColumn(self, value: bool) -> None:
1620		self._Entity.IsBeamColumn = value
1621
1622	@SuperimposeBoundaryCondition.setter
1623	def SuperimposeBoundaryCondition(self, value: int) -> None:
1624		self._Entity.SuperimposeBoundaryCondition = value
1625
1626	@IsZeroOutFeaMoments.setter
1627	def IsZeroOutFeaMoments(self, value: bool) -> None:
1628		self._Entity.IsZeroOutFeaMoments = value
1629
1630	@IsZeroOutFeaTransverseShears.setter
1631	def IsZeroOutFeaTransverseShears(self, value: bool) -> None:
1632		self._Entity.IsZeroOutFeaTransverseShears = value
1633
1634	@MechanicalLimit.setter
1635	def MechanicalLimit(self, value: float) -> None:
1636		self._Entity.MechanicalLimit = value
1637
1638	@MechanicalUltimate.setter
1639	def MechanicalUltimate(self, value: float) -> None:
1640		self._Entity.MechanicalUltimate = value
1641
1642	@ThermalHelp.setter
1643	def ThermalHelp(self, value: float) -> None:
1644		self._Entity.ThermalHelp = value
1645
1646	@ThermalHurt.setter
1647	def ThermalHurt(self, value: float) -> None:
1648		self._Entity.ThermalHurt = value
1649
1650	@FatigueKTSkin.setter
1651	def FatigueKTSkin(self, value: float) -> None:
1652		self._Entity.FatigueKTSkin = value
1653
1654	@FatigueKTStiff.setter
1655	def FatigueKTStiff(self, value: float) -> None:
1656		self._Entity.FatigueKTStiff = value
1657
1658	@XSpan.setter
1659	def XSpan(self, value: float) -> None:
1660		self._Entity.XSpan = value
1661
1662	@EARequired.setter
1663	def EARequired(self, value: float) -> None:
1664		self._Entity.EARequired = value
1665
1666	@EI1Required.setter
1667	def EI1Required(self, value: float) -> None:
1668		self._Entity.EI1Required = value
1669
1670	@EI2Required.setter
1671	def EI2Required(self, value: float) -> None:
1672		self._Entity.EI2Required = value
1673
1674	@GJRequired.setter
1675	def GJRequired(self, value: float) -> None:
1676		self._Entity.GJRequired = value
1677
1678	@Ex.setter
1679	def Ex(self, value: float) -> None:
1680		self._Entity.Ex = value
1681
1682	@Dmid.setter
1683	def Dmid(self, value: float) -> None:
1684		self._Entity.Dmid = value
1685
1686	def GetObjectName(self, objectId: types.FamilyObjectUID) -> str:
1687		return self._Entity.GetObjectName(_types.FamilyObjectUID(objectId.value))
1688
1689	def GetConceptName(self) -> str:
1690		return self._Entity.GetConceptName()
1691
1692	def GetZoneDesignResults(self, solutionId: int = 1) -> ZoneDesignResultCol:
1693		return ZoneDesignResultCol(self._Entity.GetZoneDesignResults(solutionId))
1694
1695	def RenumberZone(self, newId: int) -> ZoneIdUpdateStatus:
1696		return ZoneIdUpdateStatus[self._Entity.RenumberZone(newId).ToString()]
1697
1698	def GetAllResults(self) -> AnalysisResultCol:
1699		return AnalysisResultCol(self._Entity.GetAllResults())
1700
1701	def GetControllingResult(self) -> AnalysisResult:
1702		result = self._Entity.GetControllingResult()
1703		thisClass = type(result).__name__
1704		givenClass = AnalysisResult
1705		for subclass in AnalysisResult.__subclasses__():
1706			if subclass.__name__ == thisClass:
1707				givenClass = subclass
1708		return givenClass(result)
1709
1710	def GetMinimumMargin(self) -> Margin:
1711		return Margin(self._Entity.GetMinimumMargin())

Abstract for regular Zones and Panel Segments.

ZoneBase(zoneBase: HyperX.Scripting.ZoneBase)
1486	def __init__(self, zoneBase: _api.ZoneBase):
1487		self._Entity = zoneBase
Centroid: <property object at 0x000001C374B037E0>
1489	@property
1490	def Centroid(self) -> Centroid:
1491		result = self._Entity.Centroid
1492		return Centroid(result) if result is not None else None
Id: int
1494	@property
1495	def Id(self) -> int:
1496		return self._Entity.Id
Weight: float
1498	@property
1499	def Weight(self) -> float:
1500		return self._Entity.Weight
NonOptimumFactor: float
1502	@property
1503	def NonOptimumFactor(self) -> float:
1504		return self._Entity.NonOptimumFactor
AddedWeight: float
1506	@property
1507	def AddedWeight(self) -> float:
1508		return self._Entity.AddedWeight
SuperimposePanel: bool
1510	@property
1511	def SuperimposePanel(self) -> bool:
1512		return self._Entity.SuperimposePanel
BucklingImperfection: float
1514	@property
1515	def BucklingImperfection(self) -> float:
1516		return self._Entity.BucklingImperfection
IsBeamColumn: bool
1518	@property
1519	def IsBeamColumn(self) -> bool:
1520		return self._Entity.IsBeamColumn
SuperimposeBoundaryCondition: int
1522	@property
1523	def SuperimposeBoundaryCondition(self) -> int:
1524		return self._Entity.SuperimposeBoundaryCondition
IsZeroOutFeaMoments: bool
1526	@property
1527	def IsZeroOutFeaMoments(self) -> bool:
1528		return self._Entity.IsZeroOutFeaMoments
IsZeroOutFeaTransverseShears: bool
1530	@property
1531	def IsZeroOutFeaTransverseShears(self) -> bool:
1532		return self._Entity.IsZeroOutFeaTransverseShears
MechanicalLimit: float
1534	@property
1535	def MechanicalLimit(self) -> float:
1536		return self._Entity.MechanicalLimit
MechanicalUltimate: float
1538	@property
1539	def MechanicalUltimate(self) -> float:
1540		return self._Entity.MechanicalUltimate
ThermalHelp: float
1542	@property
1543	def ThermalHelp(self) -> float:
1544		return self._Entity.ThermalHelp
ThermalHurt: float
1546	@property
1547	def ThermalHurt(self) -> float:
1548		return self._Entity.ThermalHurt
FatigueKTSkin: float
1550	@property
1551	def FatigueKTSkin(self) -> float:
1552		return self._Entity.FatigueKTSkin
FatigueKTStiff: float
1554	@property
1555	def FatigueKTStiff(self) -> float:
1556		return self._Entity.FatigueKTStiff
XSpan: float
1558	@property
1559	def XSpan(self) -> float:
1560		return self._Entity.XSpan
EARequired: float
1562	@property
1563	def EARequired(self) -> float:
1564		return self._Entity.EARequired
EI1Required: float
1566	@property
1567	def EI1Required(self) -> float:
1568		return self._Entity.EI1Required
EI2Required: float
1570	@property
1571	def EI2Required(self) -> float:
1572		return self._Entity.EI2Required
GJRequired: float
1574	@property
1575	def GJRequired(self) -> float:
1576		return self._Entity.GJRequired
EAAuto: float
1578	@property
1579	def EAAuto(self) -> float:
1580		return self._Entity.EAAuto
EI1Auto: float
1582	@property
1583	def EI1Auto(self) -> float:
1584		return self._Entity.EI1Auto
EI2Auto: float
1586	@property
1587	def EI2Auto(self) -> float:
1588		return self._Entity.EI2Auto
GJAuto: float
1590	@property
1591	def GJAuto(self) -> float:
1592		return self._Entity.GJAuto
Ex: float
1594	@property
1595	def Ex(self) -> float:
1596		return self._Entity.Ex
Dmid: float
1598	@property
1599	def Dmid(self) -> float:
1600		return self._Entity.Dmid
def GetObjectName(self, objectId: hyperx.api.types.FamilyObjectUID) -> str:
1686	def GetObjectName(self, objectId: types.FamilyObjectUID) -> str:
1687		return self._Entity.GetObjectName(_types.FamilyObjectUID(objectId.value))
def GetConceptName(self) -> str:
1689	def GetConceptName(self) -> str:
1690		return self._Entity.GetConceptName()
def GetZoneDesignResults(self, solutionId: int = 1) -> ZoneDesignResultCol:
1692	def GetZoneDesignResults(self, solutionId: int = 1) -> ZoneDesignResultCol:
1693		return ZoneDesignResultCol(self._Entity.GetZoneDesignResults(solutionId))
def RenumberZone(self, newId: int) -> ZoneIdUpdateStatus:
1695	def RenumberZone(self, newId: int) -> ZoneIdUpdateStatus:
1696		return ZoneIdUpdateStatus[self._Entity.RenumberZone(newId).ToString()]
def GetAllResults(self) -> AnalysisResultCol:
1698	def GetAllResults(self) -> AnalysisResultCol:
1699		return AnalysisResultCol(self._Entity.GetAllResults())
def GetControllingResult(self) -> AnalysisResult:
1701	def GetControllingResult(self) -> AnalysisResult:
1702		result = self._Entity.GetControllingResult()
1703		thisClass = type(result).__name__
1704		givenClass = AnalysisResult
1705		for subclass in AnalysisResult.__subclasses__():
1706			if subclass.__name__ == thisClass:
1707				givenClass = subclass
1708		return givenClass(result)
def GetMinimumMargin(self) -> Margin:
1710	def GetMinimumMargin(self) -> Margin:
1711		return Margin(self._Entity.GetMinimumMargin())
class ElementCol(hyperx.api.IdEntityCol[hyperx.api.Element]):
1714class ElementCol(IdEntityCol[Element]):
1715	def __init__(self, elementCol: _api.ElementCol):
1716		self._Entity = elementCol
1717		self._CollectedClass = Element
1718
1719	@property
1720	def ElementColList(self) -> tuple[Element]:
1721		return tuple([Element(elementCol) for elementCol in self._Entity])
1722
1723	def __getitem__(self, index: int):
1724		return self.ElementColList[index]
1725
1726	def __iter__(self):
1727		yield from self.ElementColList
1728
1729	def __len__(self):
1730		return len(self.ElementColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

ElementCol(elementCol: HyperX.Scripting.ElementCol)
1715	def __init__(self, elementCol: _api.ElementCol):
1716		self._Entity = elementCol
1717		self._CollectedClass = Element
ElementColList: tuple[Element]
1719	@property
1720	def ElementColList(self) -> tuple[Element]:
1721		return tuple([Element(elementCol) for elementCol in self._Entity])
class PanelSegment(ZoneBase):
1733class PanelSegment(ZoneBase):
1734	def __init__(self, panelSegment: _api.PanelSegment):
1735		self._Entity = panelSegment
1736
1737	@property
1738	def ElementsByObjectOrSkin(self) -> dict[types.DiscreteDefinitionType, ElementCol]:
1739		elementsByObjectOrSkinDict = {}
1740		for kvp in self._Entity.ElementsByObjectOrSkin:
1741			elementsByObjectOrSkinDict[types.DiscreteDefinitionType[kvp.Key.ToString()]] = ElementCol(kvp.Value)
1742
1743		return elementsByObjectOrSkinDict
1744
1745	@property
1746	def Skins(self) -> tuple[types.DiscreteDefinitionType]:
1747		return tuple([types.DiscreteDefinitionType(discreteDefinitionType) for discreteDefinitionType in self._Entity.Skins])
1748
1749	@property
1750	def Objects(self) -> tuple[types.DiscreteDefinitionType]:
1751		return tuple([types.DiscreteDefinitionType(discreteDefinitionType) for discreteDefinitionType in self._Entity.Objects])
1752
1753	@property
1754	def DiscreteTechnique(self) -> types.DiscreteTechnique:
1755		return types.DiscreteTechnique[self._Entity.DiscreteTechnique.ToString()]
1756
1757	@property
1758	def LeftSkinZoneId(self) -> int:
1759		return self._Entity.LeftSkinZoneId
1760
1761	@property
1762	def RightSkinZoneId(self) -> int:
1763		return self._Entity.RightSkinZoneId
1764
1765	def GetElements(self, discreteDefinitionType: types.DiscreteDefinitionType) -> ElementCol:
1766		return ElementCol(self._Entity.GetElements(_types.DiscreteDefinitionType(discreteDefinitionType.value)))
1767
1768	def SetObjectElements(self, discreteDefinitionType: types.DiscreteDefinitionType, elementIds: tuple[int]) -> None:
1769		elementIdsList = MakeCSharpIntList(elementIds)
1770		elementIdsEnumerable = IEnumerable(elementIdsList)
1771		return self._Entity.SetObjectElements(_types.DiscreteDefinitionType(discreteDefinitionType.value), elementIdsEnumerable)

Abstract for regular Zones and Panel Segments.

PanelSegment(panelSegment: HyperX.Scripting.PanelSegment)
1734	def __init__(self, panelSegment: _api.PanelSegment):
1735		self._Entity = panelSegment
ElementsByObjectOrSkin: dict[hyperx.api.types.DiscreteDefinitionType, ElementCol]
1737	@property
1738	def ElementsByObjectOrSkin(self) -> dict[types.DiscreteDefinitionType, ElementCol]:
1739		elementsByObjectOrSkinDict = {}
1740		for kvp in self._Entity.ElementsByObjectOrSkin:
1741			elementsByObjectOrSkinDict[types.DiscreteDefinitionType[kvp.Key.ToString()]] = ElementCol(kvp.Value)
1742
1743		return elementsByObjectOrSkinDict
Skins: tuple[hyperx.api.types.DiscreteDefinitionType]
1745	@property
1746	def Skins(self) -> tuple[types.DiscreteDefinitionType]:
1747		return tuple([types.DiscreteDefinitionType(discreteDefinitionType) for discreteDefinitionType in self._Entity.Skins])
Objects: tuple[hyperx.api.types.DiscreteDefinitionType]
1749	@property
1750	def Objects(self) -> tuple[types.DiscreteDefinitionType]:
1751		return tuple([types.DiscreteDefinitionType(discreteDefinitionType) for discreteDefinitionType in self._Entity.Objects])
DiscreteTechnique: hyperx.api.types.DiscreteTechnique
1753	@property
1754	def DiscreteTechnique(self) -> types.DiscreteTechnique:
1755		return types.DiscreteTechnique[self._Entity.DiscreteTechnique.ToString()]
LeftSkinZoneId: int
1757	@property
1758	def LeftSkinZoneId(self) -> int:
1759		return self._Entity.LeftSkinZoneId
RightSkinZoneId: int
1761	@property
1762	def RightSkinZoneId(self) -> int:
1763		return self._Entity.RightSkinZoneId
def GetElements( self, discreteDefinitionType: hyperx.api.types.DiscreteDefinitionType) -> ElementCol:
1765	def GetElements(self, discreteDefinitionType: types.DiscreteDefinitionType) -> ElementCol:
1766		return ElementCol(self._Entity.GetElements(_types.DiscreteDefinitionType(discreteDefinitionType.value)))
def SetObjectElements( self, discreteDefinitionType: hyperx.api.types.DiscreteDefinitionType, elementIds: tuple[int]) -> None:
1768	def SetObjectElements(self, discreteDefinitionType: types.DiscreteDefinitionType, elementIds: tuple[int]) -> None:
1769		elementIdsList = MakeCSharpIntList(elementIds)
1770		elementIdsEnumerable = IEnumerable(elementIdsList)
1771		return self._Entity.SetObjectElements(_types.DiscreteDefinitionType(discreteDefinitionType.value), elementIdsEnumerable)
class Zone(ZoneBase):
1774class Zone(ZoneBase):
1775	'''
1776	Abstract for regular Zones (not Panel Segments).
1777	'''
1778	def __init__(self, zone: _api.Zone):
1779		self._Entity = zone
1780
1781	@property
1782	def Elements(self) -> ElementCol:
1783		result = self._Entity.Elements
1784		return ElementCol(result) if result is not None else None
1785
1786	def AddElements(self, elementIds: tuple[int]) -> None:
1787		elementIdsList = MakeCSharpIntList(elementIds)
1788		elementIdsEnumerable = IEnumerable(elementIdsList)
1789		return self._Entity.AddElements(elementIdsEnumerable)

Abstract for regular Zones (not Panel Segments).

Zone(zone: HyperX.Scripting.Zone)
1778	def __init__(self, zone: _api.Zone):
1779		self._Entity = zone
Elements: ElementCol
1781	@property
1782	def Elements(self) -> ElementCol:
1783		result = self._Entity.Elements
1784		return ElementCol(result) if result is not None else None
def AddElements(self, elementIds: tuple[int]) -> None:
1786	def AddElements(self, elementIds: tuple[int]) -> None:
1787		elementIdsList = MakeCSharpIntList(elementIds)
1788		elementIdsEnumerable = IEnumerable(elementIdsList)
1789		return self._Entity.AddElements(elementIdsEnumerable)
class EntityWithAssignablePropertiesCol(IdNameEntityCol, typing.Generic[~T]):
1792class EntityWithAssignablePropertiesCol(IdNameEntityCol, Generic[T]):
1793	def __init__(self, entityWithAssignablePropertiesCol: _api.EntityWithAssignablePropertiesCol):
1794		self._Entity = entityWithAssignablePropertiesCol
1795		self._CollectedClass = T
1796
1797	@property
1798	def EntityWithAssignablePropertiesColList(self) -> tuple[T]:
1799		if self._Entity.Count() <= 0:
1800			return ()
1801		thisClass = type(self._Entity._items[0]).__name__
1802		givenClass = T
1803		for subclass in T.__subclasses__():
1804			if subclass.__name__ == thisClass:
1805				givenClass = subclass
1806		return tuple([givenClass(entityWithAssignablePropertiesCol) for entityWithAssignablePropertiesCol in self._Entity])
1807
1808	def AssignPropertyToAll(self, property: AssignableProperty) -> PropertyAssignmentStatus:
1809		return PropertyAssignmentStatus[self._Entity.AssignPropertyToAll(property._Entity).ToString()]
1810
1811	@overload
1812	def Get(self, name: str) -> T: ...
1813
1814	@overload
1815	def Get(self, id: int) -> T: ...
1816
1817	def Get(self, item1 = None) -> T:
1818		if isinstance(item1, str):
1819			return super().Get(item1)
1820
1821		if isinstance(item1, int):
1822			return super().Get(item1)
1823
1824		return self._Entity.Get(item1)
1825
1826	def __getitem__(self, index: int):
1827		return self.EntityWithAssignablePropertiesColList[index]
1828
1829	def __iter__(self):
1830		yield from self.EntityWithAssignablePropertiesColList
1831
1832	def __len__(self):
1833		return len(self.EntityWithAssignablePropertiesColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

EntityWithAssignablePropertiesColList: tuple[~T]
1797	@property
1798	def EntityWithAssignablePropertiesColList(self) -> tuple[T]:
1799		if self._Entity.Count() <= 0:
1800			return ()
1801		thisClass = type(self._Entity._items[0]).__name__
1802		givenClass = T
1803		for subclass in T.__subclasses__():
1804			if subclass.__name__ == thisClass:
1805				givenClass = subclass
1806		return tuple([givenClass(entityWithAssignablePropertiesCol) for entityWithAssignablePropertiesCol in self._Entity])
def AssignPropertyToAll( self, property: AssignableProperty) -> PropertyAssignmentStatus:
1808	def AssignPropertyToAll(self, property: AssignableProperty) -> PropertyAssignmentStatus:
1809		return PropertyAssignmentStatus[self._Entity.AssignPropertyToAll(property._Entity).ToString()]
1836class JointCol(EntityWithAssignablePropertiesCol[Joint]):
1837	def __init__(self, jointCol: _api.JointCol):
1838		self._Entity = jointCol
1839		self._CollectedClass = Joint
1840
1841	@property
1842	def JointColList(self) -> tuple[Joint]:
1843		return tuple([Joint(jointCol) for jointCol in self._Entity])
1844
1845	@overload
1846	def Get(self, name: str) -> Joint: ...
1847
1848	@overload
1849	def Get(self, id: int) -> Joint: ...
1850
1851	def Get(self, item1 = None) -> Joint:
1852		if isinstance(item1, str):
1853			return Joint(super().Get(item1))
1854
1855		if isinstance(item1, int):
1856			return Joint(super().Get(item1))
1857
1858		return Joint(self._Entity.Get(item1))
1859
1860	def __getitem__(self, index: int):
1861		return self.JointColList[index]
1862
1863	def __iter__(self):
1864		yield from self.JointColList
1865
1866	def __len__(self):
1867		return len(self.JointColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

JointCol(jointCol: HyperX.Scripting.JointCol)
1837	def __init__(self, jointCol: _api.JointCol):
1838		self._Entity = jointCol
1839		self._CollectedClass = Joint
JointColList: tuple[Joint]
1841	@property
1842	def JointColList(self) -> tuple[Joint]:
1843		return tuple([Joint(jointCol) for jointCol in self._Entity])
def Get(self, item1=None) -> Joint:
1851	def Get(self, item1 = None) -> Joint:
1852		if isinstance(item1, str):
1853			return Joint(super().Get(item1))
1854
1855		if isinstance(item1, int):
1856			return Joint(super().Get(item1))
1857
1858		return Joint(self._Entity.Get(item1))
1870class PanelSegmentCol(EntityWithAssignablePropertiesCol[PanelSegment]):
1871	def __init__(self, panelSegmentCol: _api.PanelSegmentCol):
1872		self._Entity = panelSegmentCol
1873		self._CollectedClass = PanelSegment
1874
1875	@property
1876	def PanelSegmentColList(self) -> tuple[PanelSegment]:
1877		return tuple([PanelSegment(panelSegmentCol) for panelSegmentCol in self._Entity])
1878
1879	@overload
1880	def Get(self, name: str) -> PanelSegment: ...
1881
1882	@overload
1883	def Get(self, id: int) -> PanelSegment: ...
1884
1885	def Get(self, item1 = None) -> PanelSegment:
1886		if isinstance(item1, str):
1887			return PanelSegment(super().Get(item1))
1888
1889		if isinstance(item1, int):
1890			return PanelSegment(super().Get(item1))
1891
1892		return PanelSegment(self._Entity.Get(item1))
1893
1894	def __getitem__(self, index: int):
1895		return self.PanelSegmentColList[index]
1896
1897	def __iter__(self):
1898		yield from self.PanelSegmentColList
1899
1900	def __len__(self):
1901		return len(self.PanelSegmentColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

PanelSegmentCol(panelSegmentCol: HyperX.Scripting.PanelSegmentCol)
1871	def __init__(self, panelSegmentCol: _api.PanelSegmentCol):
1872		self._Entity = panelSegmentCol
1873		self._CollectedClass = PanelSegment
PanelSegmentColList: tuple[PanelSegment]
1875	@property
1876	def PanelSegmentColList(self) -> tuple[PanelSegment]:
1877		return tuple([PanelSegment(panelSegmentCol) for panelSegmentCol in self._Entity])
def Get(self, item1=None) -> PanelSegment:
1885	def Get(self, item1 = None) -> PanelSegment:
1886		if isinstance(item1, str):
1887			return PanelSegment(super().Get(item1))
1888
1889		if isinstance(item1, int):
1890			return PanelSegment(super().Get(item1))
1891
1892		return PanelSegment(self._Entity.Get(item1))
1904class ZoneCol(EntityWithAssignablePropertiesCol[Zone]):
1905	def __init__(self, zoneCol: _api.ZoneCol):
1906		self._Entity = zoneCol
1907		self._CollectedClass = Zone
1908
1909	@property
1910	def ZoneColList(self) -> tuple[Zone]:
1911		return tuple([Zone(zoneCol) for zoneCol in self._Entity])
1912
1913	@overload
1914	def Get(self, name: str) -> Zone: ...
1915
1916	@overload
1917	def Get(self, id: int) -> Zone: ...
1918
1919	def Get(self, item1 = None) -> Zone:
1920		if isinstance(item1, str):
1921			return Zone(super().Get(item1))
1922
1923		if isinstance(item1, int):
1924			return Zone(super().Get(item1))
1925
1926		result = self._Entity.Get(item1)
1927		thisClass = type(result).__name__
1928		givenClass = Zone
1929		for subclass in Zone.__subclasses__():
1930			if subclass.__name__ == thisClass:
1931				givenClass = subclass
1932		return givenClass(result)
1933
1934	def __getitem__(self, index: int):
1935		return self.ZoneColList[index]
1936
1937	def __iter__(self):
1938		yield from self.ZoneColList
1939
1940	def __len__(self):
1941		return len(self.ZoneColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

ZoneCol(zoneCol: HyperX.Scripting.ZoneCol)
1905	def __init__(self, zoneCol: _api.ZoneCol):
1906		self._Entity = zoneCol
1907		self._CollectedClass = Zone
ZoneColList: tuple[Zone]
1909	@property
1910	def ZoneColList(self) -> tuple[Zone]:
1911		return tuple([Zone(zoneCol) for zoneCol in self._Entity])
def Get(self, item1=None) -> Zone:
1919	def Get(self, item1 = None) -> Zone:
1920		if isinstance(item1, str):
1921			return Zone(super().Get(item1))
1922
1923		if isinstance(item1, int):
1924			return Zone(super().Get(item1))
1925
1926		result = self._Entity.Get(item1)
1927		thisClass = type(result).__name__
1928		givenClass = Zone
1929		for subclass in Zone.__subclasses__():
1930			if subclass.__name__ == thisClass:
1931				givenClass = subclass
1932		return givenClass(result)
class ZoneJointContainer(IdNameEntityRenameable):
1944class ZoneJointContainer(IdNameEntityRenameable):
1945	'''
1946	Represents an entity that contains a collection of Zones and Joints.
1947	'''
1948	def __init__(self, zoneJointContainer: _api.ZoneJointContainer):
1949		self._Entity = zoneJointContainer
1950
1951	@property
1952	def Centroid(self) -> Centroid:
1953		result = self._Entity.Centroid
1954		return Centroid(result) if result is not None else None
1955
1956	@property
1957	def Joints(self) -> JointCol:
1958		result = self._Entity.Joints
1959		return JointCol(result) if result is not None else None
1960
1961	@property
1962	def PanelSegments(self) -> PanelSegmentCol:
1963		result = self._Entity.PanelSegments
1964		return PanelSegmentCol(result) if result is not None else None
1965
1966	@property
1967	def TotalBeamLength(self) -> float:
1968		return self._Entity.TotalBeamLength
1969
1970	@property
1971	def TotalPanelArea(self) -> float:
1972		return self._Entity.TotalPanelArea
1973
1974	@property
1975	def TotalZoneWeight(self) -> float:
1976		return self._Entity.TotalZoneWeight
1977
1978	@property
1979	def Zones(self) -> ZoneCol:
1980		result = self._Entity.Zones
1981		return ZoneCol(result) if result is not None else None
1982
1983	@overload
1984	def AddJoint(self, id: int) -> CollectionModificationStatus: ...
1985
1986	@overload
1987	@abstractmethod
1988	def AddJoint(self, joint: Joint) -> CollectionModificationStatus: ...
1989
1990	@overload
1991	def RemoveJoint(self, id: int) -> CollectionModificationStatus: ...
1992
1993	@overload
1994	def RemoveJoint(self, joint: Joint) -> CollectionModificationStatus: ...
1995
1996	@overload
1997	@abstractmethod
1998	def RemoveJoints(self, jointIds: tuple[int]) -> CollectionModificationStatus: ...
1999
2000	@overload
2001	def RemoveJoints(self, joints: JointCol) -> CollectionModificationStatus: ...
2002
2003	@overload
2004	def AddZone(self, id: int) -> CollectionModificationStatus: ...
2005
2006	@overload
2007	def AddZones(self, ids: tuple[int]) -> CollectionModificationStatus: ...
2008
2009	@overload
2010	def AddZone(self, zone: Zone) -> CollectionModificationStatus: ...
2011
2012	@overload
2013	@abstractmethod
2014	def AddZones(self, zones: tuple[Zone]) -> CollectionModificationStatus: ...
2015
2016	@overload
2017	def RemoveZone(self, id: int) -> CollectionModificationStatus: ...
2018
2019	@overload
2020	def RemoveZone(self, zone: Zone) -> CollectionModificationStatus: ...
2021
2022	@overload
2023	@abstractmethod
2024	def RemoveZones(self, zoneIds: tuple[int]) -> CollectionModificationStatus: ...
2025
2026	@overload
2027	def RemoveZones(self, zones: ZoneCol) -> CollectionModificationStatus: ...
2028
2029	@overload
2030	def AddPanelSegment(self, id: int) -> CollectionModificationStatus: ...
2031
2032	@overload
2033	@abstractmethod
2034	def AddPanelSegment(self, segment: PanelSegment) -> CollectionModificationStatus: ...
2035
2036	@overload
2037	def RemovePanelSegment(self, id: int) -> CollectionModificationStatus: ...
2038
2039	@overload
2040	def RemovePanelSegment(self, segment: PanelSegment) -> CollectionModificationStatus: ...
2041
2042	@overload
2043	@abstractmethod
2044	def RemovePanelSegments(self, segmentIds: tuple[int]) -> CollectionModificationStatus: ...
2045
2046	@overload
2047	def RemovePanelSegments(self, segments: PanelSegmentCol) -> CollectionModificationStatus: ...
2048
2049	def AddJoint(self, item1 = None) -> CollectionModificationStatus:
2050		if isinstance(item1, int):
2051			return CollectionModificationStatus[self._Entity.AddJoint(item1).ToString()]
2052
2053		if isinstance(item1, Joint):
2054			return CollectionModificationStatus[self._Entity.AddJoint(item1._Entity).ToString()]
2055
2056		return CollectionModificationStatus[self._Entity.AddJoint(item1).ToString()]
2057
2058	def RemoveJoint(self, item1 = None) -> CollectionModificationStatus:
2059		if isinstance(item1, int):
2060			return CollectionModificationStatus[self._Entity.RemoveJoint(item1).ToString()]
2061
2062		if isinstance(item1, Joint):
2063			return CollectionModificationStatus[self._Entity.RemoveJoint(item1._Entity).ToString()]
2064
2065		return CollectionModificationStatus[self._Entity.RemoveJoint(item1).ToString()]
2066
2067	def RemoveJoints(self, item1 = None) -> CollectionModificationStatus:
2068		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
2069			jointIdsList = MakeCSharpIntList(item1)
2070			jointIdsEnumerable = IEnumerable(jointIdsList)
2071			return CollectionModificationStatus[self._Entity.RemoveJoints(jointIdsEnumerable).ToString()]
2072
2073		if isinstance(item1, JointCol):
2074			return CollectionModificationStatus[self._Entity.RemoveJoints(item1._Entity).ToString()]
2075
2076		return CollectionModificationStatus[self._Entity.RemoveJoints(item1).ToString()]
2077
2078	def AddZone(self, item1 = None) -> CollectionModificationStatus:
2079		if isinstance(item1, int):
2080			return CollectionModificationStatus[self._Entity.AddZone(item1).ToString()]
2081
2082		if isinstance(item1, Zone):
2083			return CollectionModificationStatus[self._Entity.AddZone(item1._Entity).ToString()]
2084
2085		return CollectionModificationStatus[self._Entity.AddZone(item1).ToString()]
2086
2087	def AddZones(self, item1 = None) -> CollectionModificationStatus:
2088		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
2089			idsList = MakeCSharpIntList(item1)
2090			idsEnumerable = IEnumerable(idsList)
2091			return CollectionModificationStatus[self._Entity.AddZones(idsEnumerable).ToString()]
2092
2093		if isinstance(item1, tuple) and item1 and isinstance(item1[0], Zone):
2094			zonesList = List[_api.Zone]()
2095			if item1 is not None:
2096				for thing in item1:
2097					if thing is not None:
2098						zonesList.Add(thing._Entity)
2099			zonesEnumerable = IEnumerable(zonesList)
2100			return CollectionModificationStatus[self._Entity.AddZones(zonesEnumerable).ToString()]
2101
2102		return CollectionModificationStatus[self._Entity.AddZones(item1).ToString()]
2103
2104	def RemoveZone(self, item1 = None) -> CollectionModificationStatus:
2105		if isinstance(item1, int):
2106			return CollectionModificationStatus[self._Entity.RemoveZone(item1).ToString()]
2107
2108		if isinstance(item1, Zone):
2109			return CollectionModificationStatus[self._Entity.RemoveZone(item1._Entity).ToString()]
2110
2111		return CollectionModificationStatus[self._Entity.RemoveZone(item1).ToString()]
2112
2113	def RemoveZones(self, item1 = None) -> CollectionModificationStatus:
2114		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
2115			zoneIdsList = MakeCSharpIntList(item1)
2116			zoneIdsEnumerable = IEnumerable(zoneIdsList)
2117			return CollectionModificationStatus[self._Entity.RemoveZones(zoneIdsEnumerable).ToString()]
2118
2119		if isinstance(item1, ZoneCol):
2120			return CollectionModificationStatus[self._Entity.RemoveZones(item1._Entity).ToString()]
2121
2122		return CollectionModificationStatus[self._Entity.RemoveZones(item1).ToString()]
2123
2124	def AddPanelSegment(self, item1 = None) -> CollectionModificationStatus:
2125		if isinstance(item1, int):
2126			return CollectionModificationStatus[self._Entity.AddPanelSegment(item1).ToString()]
2127
2128		if isinstance(item1, PanelSegment):
2129			return CollectionModificationStatus[self._Entity.AddPanelSegment(item1._Entity).ToString()]
2130
2131		return CollectionModificationStatus[self._Entity.AddPanelSegment(item1).ToString()]
2132
2133	def RemovePanelSegment(self, item1 = None) -> CollectionModificationStatus:
2134		if isinstance(item1, int):
2135			return CollectionModificationStatus[self._Entity.RemovePanelSegment(item1).ToString()]
2136
2137		if isinstance(item1, PanelSegment):
2138			return CollectionModificationStatus[self._Entity.RemovePanelSegment(item1._Entity).ToString()]
2139
2140		return CollectionModificationStatus[self._Entity.RemovePanelSegment(item1).ToString()]
2141
2142	def RemovePanelSegments(self, item1 = None) -> CollectionModificationStatus:
2143		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
2144			segmentIdsList = MakeCSharpIntList(item1)
2145			segmentIdsEnumerable = IEnumerable(segmentIdsList)
2146			return CollectionModificationStatus[self._Entity.RemovePanelSegments(segmentIdsEnumerable).ToString()]
2147
2148		if isinstance(item1, PanelSegmentCol):
2149			return CollectionModificationStatus[self._Entity.RemovePanelSegments(item1._Entity).ToString()]
2150
2151		return CollectionModificationStatus[self._Entity.RemovePanelSegments(item1).ToString()]

Represents an entity that contains a collection of Zones and Joints.

ZoneJointContainer(zoneJointContainer: HyperX.Scripting.ZoneJointContainer)
1948	def __init__(self, zoneJointContainer: _api.ZoneJointContainer):
1949		self._Entity = zoneJointContainer
Centroid: <property object at 0x000001C374B2C720>
1951	@property
1952	def Centroid(self) -> Centroid:
1953		result = self._Entity.Centroid
1954		return Centroid(result) if result is not None else None
Joints: JointCol
1956	@property
1957	def Joints(self) -> JointCol:
1958		result = self._Entity.Joints
1959		return JointCol(result) if result is not None else None
PanelSegments: PanelSegmentCol
1961	@property
1962	def PanelSegments(self) -> PanelSegmentCol:
1963		result = self._Entity.PanelSegments
1964		return PanelSegmentCol(result) if result is not None else None
TotalBeamLength: float
1966	@property
1967	def TotalBeamLength(self) -> float:
1968		return self._Entity.TotalBeamLength
TotalPanelArea: float
1970	@property
1971	def TotalPanelArea(self) -> float:
1972		return self._Entity.TotalPanelArea
TotalZoneWeight: float
1974	@property
1975	def TotalZoneWeight(self) -> float:
1976		return self._Entity.TotalZoneWeight
Zones: ZoneCol
1978	@property
1979	def Zones(self) -> ZoneCol:
1980		result = self._Entity.Zones
1981		return ZoneCol(result) if result is not None else None
def AddJoint(self, item1=None) -> CollectionModificationStatus:
2049	def AddJoint(self, item1 = None) -> CollectionModificationStatus:
2050		if isinstance(item1, int):
2051			return CollectionModificationStatus[self._Entity.AddJoint(item1).ToString()]
2052
2053		if isinstance(item1, Joint):
2054			return CollectionModificationStatus[self._Entity.AddJoint(item1._Entity).ToString()]
2055
2056		return CollectionModificationStatus[self._Entity.AddJoint(item1).ToString()]
def RemoveJoint(self, item1=None) -> CollectionModificationStatus:
2058	def RemoveJoint(self, item1 = None) -> CollectionModificationStatus:
2059		if isinstance(item1, int):
2060			return CollectionModificationStatus[self._Entity.RemoveJoint(item1).ToString()]
2061
2062		if isinstance(item1, Joint):
2063			return CollectionModificationStatus[self._Entity.RemoveJoint(item1._Entity).ToString()]
2064
2065		return CollectionModificationStatus[self._Entity.RemoveJoint(item1).ToString()]
def RemoveJoints(self, item1=None) -> CollectionModificationStatus:
2067	def RemoveJoints(self, item1 = None) -> CollectionModificationStatus:
2068		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
2069			jointIdsList = MakeCSharpIntList(item1)
2070			jointIdsEnumerable = IEnumerable(jointIdsList)
2071			return CollectionModificationStatus[self._Entity.RemoveJoints(jointIdsEnumerable).ToString()]
2072
2073		if isinstance(item1, JointCol):
2074			return CollectionModificationStatus[self._Entity.RemoveJoints(item1._Entity).ToString()]
2075
2076		return CollectionModificationStatus[self._Entity.RemoveJoints(item1).ToString()]
def AddZone(self, item1=None) -> CollectionModificationStatus:
2078	def AddZone(self, item1 = None) -> CollectionModificationStatus:
2079		if isinstance(item1, int):
2080			return CollectionModificationStatus[self._Entity.AddZone(item1).ToString()]
2081
2082		if isinstance(item1, Zone):
2083			return CollectionModificationStatus[self._Entity.AddZone(item1._Entity).ToString()]
2084
2085		return CollectionModificationStatus[self._Entity.AddZone(item1).ToString()]
def AddZones(self, item1=None) -> CollectionModificationStatus:
2087	def AddZones(self, item1 = None) -> CollectionModificationStatus:
2088		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
2089			idsList = MakeCSharpIntList(item1)
2090			idsEnumerable = IEnumerable(idsList)
2091			return CollectionModificationStatus[self._Entity.AddZones(idsEnumerable).ToString()]
2092
2093		if isinstance(item1, tuple) and item1 and isinstance(item1[0], Zone):
2094			zonesList = List[_api.Zone]()
2095			if item1 is not None:
2096				for thing in item1:
2097					if thing is not None:
2098						zonesList.Add(thing._Entity)
2099			zonesEnumerable = IEnumerable(zonesList)
2100			return CollectionModificationStatus[self._Entity.AddZones(zonesEnumerable).ToString()]
2101
2102		return CollectionModificationStatus[self._Entity.AddZones(item1).ToString()]
def RemoveZone(self, item1=None) -> CollectionModificationStatus:
2104	def RemoveZone(self, item1 = None) -> CollectionModificationStatus:
2105		if isinstance(item1, int):
2106			return CollectionModificationStatus[self._Entity.RemoveZone(item1).ToString()]
2107
2108		if isinstance(item1, Zone):
2109			return CollectionModificationStatus[self._Entity.RemoveZone(item1._Entity).ToString()]
2110
2111		return CollectionModificationStatus[self._Entity.RemoveZone(item1).ToString()]
def RemoveZones(self, item1=None) -> CollectionModificationStatus:
2113	def RemoveZones(self, item1 = None) -> CollectionModificationStatus:
2114		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
2115			zoneIdsList = MakeCSharpIntList(item1)
2116			zoneIdsEnumerable = IEnumerable(zoneIdsList)
2117			return CollectionModificationStatus[self._Entity.RemoveZones(zoneIdsEnumerable).ToString()]
2118
2119		if isinstance(item1, ZoneCol):
2120			return CollectionModificationStatus[self._Entity.RemoveZones(item1._Entity).ToString()]
2121
2122		return CollectionModificationStatus[self._Entity.RemoveZones(item1).ToString()]
def AddPanelSegment(self, item1=None) -> CollectionModificationStatus:
2124	def AddPanelSegment(self, item1 = None) -> CollectionModificationStatus:
2125		if isinstance(item1, int):
2126			return CollectionModificationStatus[self._Entity.AddPanelSegment(item1).ToString()]
2127
2128		if isinstance(item1, PanelSegment):
2129			return CollectionModificationStatus[self._Entity.AddPanelSegment(item1._Entity).ToString()]
2130
2131		return CollectionModificationStatus[self._Entity.AddPanelSegment(item1).ToString()]
def RemovePanelSegment(self, item1=None) -> CollectionModificationStatus:
2133	def RemovePanelSegment(self, item1 = None) -> CollectionModificationStatus:
2134		if isinstance(item1, int):
2135			return CollectionModificationStatus[self._Entity.RemovePanelSegment(item1).ToString()]
2136
2137		if isinstance(item1, PanelSegment):
2138			return CollectionModificationStatus[self._Entity.RemovePanelSegment(item1._Entity).ToString()]
2139
2140		return CollectionModificationStatus[self._Entity.RemovePanelSegment(item1).ToString()]
def RemovePanelSegments(self, item1=None) -> CollectionModificationStatus:
2142	def RemovePanelSegments(self, item1 = None) -> CollectionModificationStatus:
2143		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
2144			segmentIdsList = MakeCSharpIntList(item1)
2145			segmentIdsEnumerable = IEnumerable(segmentIdsList)
2146			return CollectionModificationStatus[self._Entity.RemovePanelSegments(segmentIdsEnumerable).ToString()]
2147
2148		if isinstance(item1, PanelSegmentCol):
2149			return CollectionModificationStatus[self._Entity.RemovePanelSegments(item1._Entity).ToString()]
2150
2151		return CollectionModificationStatus[self._Entity.RemovePanelSegments(item1).ToString()]
class AutomatedConstraint(IdNameEntityRenameable):
2154class AutomatedConstraint(IdNameEntityRenameable):
2155	def __init__(self, automatedConstraint: _api.AutomatedConstraint):
2156		self._Entity = automatedConstraint
2157
2158	@property
2159	def ConstraintType(self) -> types.StiffnessCriteriaType:
2160		return types.StiffnessCriteriaType[self._Entity.ConstraintType.ToString()]
2161
2162	@property
2163	def Set(self) -> str:
2164		return self._Entity.Set
2165
2166	@property
2167	def DesignLoadCases(self) -> list[str]:
2168		return [string for string in self._Entity.DesignLoadCases]
2169
2170	@Set.setter
2171	def Set(self, value: str) -> None:
2172		self._Entity.Set = value
2173
2174	def AddDesignLoadCases(self, designLoadCases: list[str]) -> None:
2175		designLoadCasesList = List[str]()
2176		if designLoadCases is not None:
2177			for thing in designLoadCases:
2178				if thing is not None:
2179					designLoadCasesList.Add(thing)
2180		return self._Entity.AddDesignLoadCases(designLoadCasesList)
2181
2182	def RemoveDesignLoadCases(self, designLoadCases: list[str]) -> None:
2183		designLoadCasesList = List[str]()
2184		if designLoadCases is not None:
2185			for thing in designLoadCases:
2186				if thing is not None:
2187					designLoadCasesList.Add(thing)
2188		return self._Entity.RemoveDesignLoadCases(designLoadCasesList)

Represents an entity with an ID and Name.

AutomatedConstraint(automatedConstraint: HyperX.Scripting.AutomatedConstraint)
2155	def __init__(self, automatedConstraint: _api.AutomatedConstraint):
2156		self._Entity = automatedConstraint
ConstraintType: hyperx.api.types.StiffnessCriteriaType
2158	@property
2159	def ConstraintType(self) -> types.StiffnessCriteriaType:
2160		return types.StiffnessCriteriaType[self._Entity.ConstraintType.ToString()]
Set: str
2162	@property
2163	def Set(self) -> str:
2164		return self._Entity.Set
DesignLoadCases: list[str]
2166	@property
2167	def DesignLoadCases(self) -> list[str]:
2168		return [string for string in self._Entity.DesignLoadCases]
def AddDesignLoadCases(self, designLoadCases: list[str]) -> None:
2174	def AddDesignLoadCases(self, designLoadCases: list[str]) -> None:
2175		designLoadCasesList = List[str]()
2176		if designLoadCases is not None:
2177			for thing in designLoadCases:
2178				if thing is not None:
2179					designLoadCasesList.Add(thing)
2180		return self._Entity.AddDesignLoadCases(designLoadCasesList)
def RemoveDesignLoadCases(self, designLoadCases: list[str]) -> None:
2182	def RemoveDesignLoadCases(self, designLoadCases: list[str]) -> None:
2183		designLoadCasesList = List[str]()
2184		if designLoadCases is not None:
2185			for thing in designLoadCases:
2186				if thing is not None:
2187					designLoadCasesList.Add(thing)
2188		return self._Entity.RemoveDesignLoadCases(designLoadCasesList)
class ModalAutomatedConstraint(AutomatedConstraint):
2191class ModalAutomatedConstraint(AutomatedConstraint):
2192	def __init__(self, modalAutomatedConstraint: _api.ModalAutomatedConstraint):
2193		self._Entity = modalAutomatedConstraint
2194
2195	@property
2196	def Eigenvalue(self) -> float:
2197		return self._Entity.Eigenvalue
2198
2199	@Eigenvalue.setter
2200	def Eigenvalue(self, value: float) -> None:
2201		self._Entity.Eigenvalue = value

Represents an entity with an ID and Name.

ModalAutomatedConstraint(modalAutomatedConstraint: HyperX.Scripting.ModalAutomatedConstraint)
2192	def __init__(self, modalAutomatedConstraint: _api.ModalAutomatedConstraint):
2193		self._Entity = modalAutomatedConstraint
Eigenvalue: float
2195	@property
2196	def Eigenvalue(self) -> float:
2197		return self._Entity.Eigenvalue
class BucklingAutomatedConstraint(ModalAutomatedConstraint):
2204class BucklingAutomatedConstraint(ModalAutomatedConstraint):
2205	def __init__(self, bucklingAutomatedConstraint: _api.BucklingAutomatedConstraint):
2206		self._Entity = bucklingAutomatedConstraint

Represents an entity with an ID and Name.

BucklingAutomatedConstraint( bucklingAutomatedConstraint: HyperX.Scripting.BucklingAutomatedConstraint)
2205	def __init__(self, bucklingAutomatedConstraint: _api.BucklingAutomatedConstraint):
2206		self._Entity = bucklingAutomatedConstraint
class StaticAutomatedConstraint(AutomatedConstraint):
2209class StaticAutomatedConstraint(AutomatedConstraint):
2210	def __init__(self, staticAutomatedConstraint: _api.StaticAutomatedConstraint):
2211		self._Entity = staticAutomatedConstraint
2212
2213	@property
2214	def VirtualDesignLoad(self) -> str:
2215		return self._Entity.VirtualDesignLoad
2216
2217	@property
2218	def GridId(self) -> int:
2219		return self._Entity.GridId
2220
2221	@property
2222	def Orientation(self) -> types.DisplacementShapeType:
2223		return types.DisplacementShapeType[self._Entity.Orientation.ToString()]
2224
2225	@property
2226	def HasVector(self) -> bool:
2227		return self._Entity.HasVector
2228
2229	@property
2230	def X(self) -> float:
2231		return self._Entity.X
2232
2233	@property
2234	def Y(self) -> float:
2235		return self._Entity.Y
2236
2237	@property
2238	def Z(self) -> float:
2239		return self._Entity.Z
2240
2241	@VirtualDesignLoad.setter
2242	def VirtualDesignLoad(self, value: str) -> None:
2243		self._Entity.VirtualDesignLoad = value
2244
2245	@GridId.setter
2246	def GridId(self, value: int) -> None:
2247		self._Entity.GridId = value
2248
2249	@Orientation.setter
2250	def Orientation(self, value: types.DisplacementShapeType) -> None:
2251		self._Entity.Orientation = _types.DisplacementShapeType(value.value)
2252
2253	@X.setter
2254	def X(self, value: float) -> None:
2255		self._Entity.X = value
2256
2257	@Y.setter
2258	def Y(self, value: float) -> None:
2259		self._Entity.Y = value
2260
2261	@Z.setter
2262	def Z(self, value: float) -> None:
2263		self._Entity.Z = value

Represents an entity with an ID and Name.

StaticAutomatedConstraint( staticAutomatedConstraint: HyperX.Scripting.StaticAutomatedConstraint)
2210	def __init__(self, staticAutomatedConstraint: _api.StaticAutomatedConstraint):
2211		self._Entity = staticAutomatedConstraint
VirtualDesignLoad: str
2213	@property
2214	def VirtualDesignLoad(self) -> str:
2215		return self._Entity.VirtualDesignLoad
GridId: int
2217	@property
2218	def GridId(self) -> int:
2219		return self._Entity.GridId
Orientation: hyperx.api.types.DisplacementShapeType
2221	@property
2222	def Orientation(self) -> types.DisplacementShapeType:
2223		return types.DisplacementShapeType[self._Entity.Orientation.ToString()]
HasVector: bool
2225	@property
2226	def HasVector(self) -> bool:
2227		return self._Entity.HasVector
X: float
2229	@property
2230	def X(self) -> float:
2231		return self._Entity.X
Y: float
2233	@property
2234	def Y(self) -> float:
2235		return self._Entity.Y
Z: float
2237	@property
2238	def Z(self) -> float:
2239		return self._Entity.Z
class DisplacementAutomatedConstraint(StaticAutomatedConstraint):
2266class DisplacementAutomatedConstraint(StaticAutomatedConstraint):
2267	def __init__(self, displacementAutomatedConstraint: _api.DisplacementAutomatedConstraint):
2268		self._Entity = displacementAutomatedConstraint
2269
2270	@property
2271	def Limit(self) -> float:
2272		return self._Entity.Limit
2273
2274	@Limit.setter
2275	def Limit(self, value: float) -> None:
2276		self._Entity.Limit = value

Represents an entity with an ID and Name.

DisplacementAutomatedConstraint( displacementAutomatedConstraint: HyperX.Scripting.DisplacementAutomatedConstraint)
2267	def __init__(self, displacementAutomatedConstraint: _api.DisplacementAutomatedConstraint):
2268		self._Entity = displacementAutomatedConstraint
Limit: float
2270	@property
2271	def Limit(self) -> float:
2272		return self._Entity.Limit
class FrequencyAutomatedConstraint(ModalAutomatedConstraint):
2279class FrequencyAutomatedConstraint(ModalAutomatedConstraint):
2280	def __init__(self, frequencyAutomatedConstraint: _api.FrequencyAutomatedConstraint):
2281		self._Entity = frequencyAutomatedConstraint

Represents an entity with an ID and Name.

FrequencyAutomatedConstraint( frequencyAutomatedConstraint: HyperX.Scripting.FrequencyAutomatedConstraint)
2280	def __init__(self, frequencyAutomatedConstraint: _api.FrequencyAutomatedConstraint):
2281		self._Entity = frequencyAutomatedConstraint
class RotationAutomatedConstraint(StaticAutomatedConstraint):
2284class RotationAutomatedConstraint(StaticAutomatedConstraint):
2285	def __init__(self, rotationAutomatedConstraint: _api.RotationAutomatedConstraint):
2286		self._Entity = rotationAutomatedConstraint
2287
2288	@property
2289	def Limit(self) -> float:
2290		return self._Entity.Limit
2291
2292	@Limit.setter
2293	def Limit(self, value: float) -> None:
2294		self._Entity.Limit = value

Represents an entity with an ID and Name.

RotationAutomatedConstraint( rotationAutomatedConstraint: HyperX.Scripting.RotationAutomatedConstraint)
2285	def __init__(self, rotationAutomatedConstraint: _api.RotationAutomatedConstraint):
2286		self._Entity = rotationAutomatedConstraint
Limit: float
2288	@property
2289	def Limit(self) -> float:
2290		return self._Entity.Limit
class ManualConstraint(IdNameEntityRenameable):
2297class ManualConstraint(IdNameEntityRenameable):
2298	def __init__(self, manualConstraint: _api.ManualConstraint):
2299		self._Entity = manualConstraint
2300
2301	@property
2302	def ConstraintType(self) -> types.ConstraintType:
2303		return types.ConstraintType[self._Entity.ConstraintType.ToString()]
2304
2305	@property
2306	def Set(self) -> str:
2307		return self._Entity.Set
2308
2309	@property
2310	def Limit(self) -> float:
2311		return self._Entity.Limit
2312
2313	@property
2314	def A11(self) -> bool:
2315		return self._Entity.A11
2316
2317	@property
2318	def A22(self) -> bool:
2319		return self._Entity.A22
2320
2321	@property
2322	def A33(self) -> bool:
2323		return self._Entity.A33
2324
2325	@property
2326	def D11(self) -> bool:
2327		return self._Entity.D11
2328
2329	@property
2330	def D22(self) -> bool:
2331		return self._Entity.D22
2332
2333	@property
2334	def D33(self) -> bool:
2335		return self._Entity.D33
2336
2337	@property
2338	def EA(self) -> bool:
2339		return self._Entity.EA
2340
2341	@property
2342	def EI1(self) -> bool:
2343		return self._Entity.EI1
2344
2345	@property
2346	def EI2(self) -> bool:
2347		return self._Entity.EI2
2348
2349	@property
2350	def GJ(self) -> bool:
2351		return self._Entity.GJ
2352
2353	@property
2354	def IsActive(self) -> bool:
2355		return self._Entity.IsActive
2356
2357	@Set.setter
2358	def Set(self, value: str) -> None:
2359		self._Entity.Set = value
2360
2361	@Limit.setter
2362	def Limit(self, value: float) -> None:
2363		self._Entity.Limit = value
2364
2365	@A11.setter
2366	def A11(self, value: bool) -> None:
2367		self._Entity.A11 = value
2368
2369	@A22.setter
2370	def A22(self, value: bool) -> None:
2371		self._Entity.A22 = value
2372
2373	@A33.setter
2374	def A33(self, value: bool) -> None:
2375		self._Entity.A33 = value
2376
2377	@D11.setter
2378	def D11(self, value: bool) -> None:
2379		self._Entity.D11 = value
2380
2381	@D22.setter
2382	def D22(self, value: bool) -> None:
2383		self._Entity.D22 = value
2384
2385	@D33.setter
2386	def D33(self, value: bool) -> None:
2387		self._Entity.D33 = value
2388
2389	@EA.setter
2390	def EA(self, value: bool) -> None:
2391		self._Entity.EA = value
2392
2393	@EI1.setter
2394	def EI1(self, value: bool) -> None:
2395		self._Entity.EI1 = value
2396
2397	@EI2.setter
2398	def EI2(self, value: bool) -> None:
2399		self._Entity.EI2 = value
2400
2401	@GJ.setter
2402	def GJ(self, value: bool) -> None:
2403		self._Entity.GJ = value
2404
2405	@IsActive.setter
2406	def IsActive(self, value: bool) -> None:
2407		self._Entity.IsActive = value

Represents an entity with an ID and Name.

ManualConstraint(manualConstraint: HyperX.Scripting.ManualConstraint)
2298	def __init__(self, manualConstraint: _api.ManualConstraint):
2299		self._Entity = manualConstraint
ConstraintType: hyperx.api.types.ConstraintType
2301	@property
2302	def ConstraintType(self) -> types.ConstraintType:
2303		return types.ConstraintType[self._Entity.ConstraintType.ToString()]
Set: str
2305	@property
2306	def Set(self) -> str:
2307		return self._Entity.Set
Limit: float
2309	@property
2310	def Limit(self) -> float:
2311		return self._Entity.Limit
A11: bool
2313	@property
2314	def A11(self) -> bool:
2315		return self._Entity.A11
A22: bool
2317	@property
2318	def A22(self) -> bool:
2319		return self._Entity.A22
A33: bool
2321	@property
2322	def A33(self) -> bool:
2323		return self._Entity.A33
D11: bool
2325	@property
2326	def D11(self) -> bool:
2327		return self._Entity.D11
D22: bool
2329	@property
2330	def D22(self) -> bool:
2331		return self._Entity.D22
D33: bool
2333	@property
2334	def D33(self) -> bool:
2335		return self._Entity.D33
EA: bool
2337	@property
2338	def EA(self) -> bool:
2339		return self._Entity.EA
EI1: bool
2341	@property
2342	def EI1(self) -> bool:
2343		return self._Entity.EI1
EI2: bool
2345	@property
2346	def EI2(self) -> bool:
2347		return self._Entity.EI2
GJ: bool
2349	@property
2350	def GJ(self) -> bool:
2351		return self._Entity.GJ
IsActive: bool
2353	@property
2354	def IsActive(self) -> bool:
2355		return self._Entity.IsActive
class ManualConstraintWithDesignLoad(ManualConstraint):
2410class ManualConstraintWithDesignLoad(ManualConstraint):
2411	def __init__(self, manualConstraintWithDesignLoad: _api.ManualConstraintWithDesignLoad):
2412		self._Entity = manualConstraintWithDesignLoad
2413
2414	@property
2415	def UseAllDesignLoads(self) -> bool:
2416		return self._Entity.UseAllDesignLoads
2417
2418	@property
2419	def DesignLoadCase(self) -> str:
2420		return self._Entity.DesignLoadCase
2421
2422	@UseAllDesignLoads.setter
2423	def UseAllDesignLoads(self, value: bool) -> None:
2424		self._Entity.UseAllDesignLoads = value
2425
2426	@DesignLoadCase.setter
2427	def DesignLoadCase(self, value: str) -> None:
2428		self._Entity.DesignLoadCase = value

Represents an entity with an ID and Name.

ManualConstraintWithDesignLoad( manualConstraintWithDesignLoad: HyperX.Scripting.ManualConstraintWithDesignLoad)
2411	def __init__(self, manualConstraintWithDesignLoad: _api.ManualConstraintWithDesignLoad):
2412		self._Entity = manualConstraintWithDesignLoad
UseAllDesignLoads: bool
2414	@property
2415	def UseAllDesignLoads(self) -> bool:
2416		return self._Entity.UseAllDesignLoads
DesignLoadCase: str
2418	@property
2419	def DesignLoadCase(self) -> str:
2420		return self._Entity.DesignLoadCase
class BucklingManualConstraint(ManualConstraintWithDesignLoad):
2431class BucklingManualConstraint(ManualConstraintWithDesignLoad):
2432	def __init__(self, bucklingManualConstraint: _api.BucklingManualConstraint):
2433		self._Entity = bucklingManualConstraint

Represents an entity with an ID and Name.

BucklingManualConstraint(bucklingManualConstraint: HyperX.Scripting.BucklingManualConstraint)
2432	def __init__(self, bucklingManualConstraint: _api.BucklingManualConstraint):
2433		self._Entity = bucklingManualConstraint
class DisplacementManualConstraint(ManualConstraintWithDesignLoad):
2436class DisplacementManualConstraint(ManualConstraintWithDesignLoad):
2437	def __init__(self, displacementManualConstraint: _api.DisplacementManualConstraint):
2438		self._Entity = displacementManualConstraint
2439
2440	@property
2441	def DOF(self) -> types.DegreeOfFreedom:
2442		return types.DegreeOfFreedom[self._Entity.DOF.ToString()]
2443
2444	@property
2445	def Nodes(self) -> list[int]:
2446		return [int32 for int32 in self._Entity.Nodes]
2447
2448	@property
2449	def RefNodes(self) -> list[int]:
2450		return [int32 for int32 in self._Entity.RefNodes]
2451
2452	@DOF.setter
2453	def DOF(self, value: types.DegreeOfFreedom) -> None:
2454		self._Entity.DOF = _types.DegreeOfFreedom(value.value)
2455
2456	def AddNodes(self, ids: list[int]) -> None:
2457		idsList = MakeCSharpIntList(ids)
2458		return self._Entity.AddNodes(idsList)
2459
2460	def RemoveNodes(self, ids: list[int]) -> None:
2461		idsList = MakeCSharpIntList(ids)
2462		return self._Entity.RemoveNodes(idsList)
2463
2464	def AddRefNodes(self, ids: list[int]) -> None:
2465		idsList = MakeCSharpIntList(ids)
2466		return self._Entity.AddRefNodes(idsList)
2467
2468	def RemoveRefNodes(self, ids: list[int]) -> None:
2469		idsList = MakeCSharpIntList(ids)
2470		return self._Entity.RemoveRefNodes(idsList)

Represents an entity with an ID and Name.

DisplacementManualConstraint( displacementManualConstraint: HyperX.Scripting.DisplacementManualConstraint)
2437	def __init__(self, displacementManualConstraint: _api.DisplacementManualConstraint):
2438		self._Entity = displacementManualConstraint
2440	@property
2441	def DOF(self) -> types.DegreeOfFreedom:
2442		return types.DegreeOfFreedom[self._Entity.DOF.ToString()]
Nodes: list[int]
2444	@property
2445	def Nodes(self) -> list[int]:
2446		return [int32 for int32 in self._Entity.Nodes]
RefNodes: list[int]
2448	@property
2449	def RefNodes(self) -> list[int]:
2450		return [int32 for int32 in self._Entity.RefNodes]
def AddNodes(self, ids: list[int]) -> None:
2456	def AddNodes(self, ids: list[int]) -> None:
2457		idsList = MakeCSharpIntList(ids)
2458		return self._Entity.AddNodes(idsList)
def RemoveNodes(self, ids: list[int]) -> None:
2460	def RemoveNodes(self, ids: list[int]) -> None:
2461		idsList = MakeCSharpIntList(ids)
2462		return self._Entity.RemoveNodes(idsList)
def AddRefNodes(self, ids: list[int]) -> None:
2464	def AddRefNodes(self, ids: list[int]) -> None:
2465		idsList = MakeCSharpIntList(ids)
2466		return self._Entity.AddRefNodes(idsList)
def RemoveRefNodes(self, ids: list[int]) -> None:
2468	def RemoveRefNodes(self, ids: list[int]) -> None:
2469		idsList = MakeCSharpIntList(ids)
2470		return self._Entity.RemoveRefNodes(idsList)
class FrequencyManualConstraint(ManualConstraintWithDesignLoad):
2473class FrequencyManualConstraint(ManualConstraintWithDesignLoad):
2474	def __init__(self, frequencyManualConstraint: _api.FrequencyManualConstraint):
2475		self._Entity = frequencyManualConstraint

Represents an entity with an ID and Name.

FrequencyManualConstraint( frequencyManualConstraint: HyperX.Scripting.FrequencyManualConstraint)
2474	def __init__(self, frequencyManualConstraint: _api.FrequencyManualConstraint):
2475		self._Entity = frequencyManualConstraint
class StaticMomentManualConstraint(ManualConstraint):
2478class StaticMomentManualConstraint(ManualConstraint):
2479	def __init__(self, staticMomentManualConstraint: _api.StaticMomentManualConstraint):
2480		self._Entity = staticMomentManualConstraint

Represents an entity with an ID and Name.

StaticMomentManualConstraint( staticMomentManualConstraint: HyperX.Scripting.StaticMomentManualConstraint)
2479	def __init__(self, staticMomentManualConstraint: _api.StaticMomentManualConstraint):
2480		self._Entity = staticMomentManualConstraint
class AutomatedConstraintCol(hyperx.api.IdNameEntityCol[hyperx.api.AutomatedConstraint]):
2483class AutomatedConstraintCol(IdNameEntityCol[AutomatedConstraint]):
2484	def __init__(self, automatedConstraintCol: _api.AutomatedConstraintCol):
2485		self._Entity = automatedConstraintCol
2486		self._CollectedClass = AutomatedConstraint
2487
2488	@property
2489	def AutomatedConstraintColList(self) -> tuple[AutomatedConstraint]:
2490		return tuple([AutomatedConstraint(automatedConstraintCol) for automatedConstraintCol in self._Entity])
2491
2492	def AddBucklingConstraint(self, designLoads: list[str], eigenvalue: float, name: str = None) -> BucklingAutomatedConstraint:
2493		designLoadsList = List[str]()
2494		if designLoads is not None:
2495			for thing in designLoads:
2496				if thing is not None:
2497					designLoadsList.Add(thing)
2498		return BucklingAutomatedConstraint(self._Entity.AddBucklingConstraint(designLoadsList, eigenvalue, name))
2499
2500	def AddFrequencyConstraint(self, designLoads: list[str], eigenvalue: float, name: str = None) -> FrequencyAutomatedConstraint:
2501		designLoadsList = List[str]()
2502		if designLoads is not None:
2503			for thing in designLoads:
2504				if thing is not None:
2505					designLoadsList.Add(thing)
2506		return FrequencyAutomatedConstraint(self._Entity.AddFrequencyConstraint(designLoadsList, eigenvalue, name))
2507
2508	def AddDisplacementConstraint(self, designLoads: list[str], gridId: int, limit: float, name: str = None) -> DisplacementAutomatedConstraint:
2509		designLoadsList = List[str]()
2510		if designLoads is not None:
2511			for thing in designLoads:
2512				if thing is not None:
2513					designLoadsList.Add(thing)
2514		return DisplacementAutomatedConstraint(self._Entity.AddDisplacementConstraint(designLoadsList, gridId, limit, name))
2515
2516	def AddRotationConstraint(self, designLoads: list[str], gridId: int, limit: float, name: str = None) -> RotationAutomatedConstraint:
2517		designLoadsList = List[str]()
2518		if designLoads is not None:
2519			for thing in designLoads:
2520				if thing is not None:
2521					designLoadsList.Add(thing)
2522		return RotationAutomatedConstraint(self._Entity.AddRotationConstraint(designLoadsList, gridId, limit, name))
2523
2524	@overload
2525	def Delete(self, id: int) -> bool: ...
2526
2527	@overload
2528	def Delete(self, name: str) -> bool: ...
2529
2530	@overload
2531	def GetBuckling(self, id: int) -> BucklingAutomatedConstraint: ...
2532
2533	@overload
2534	def GetBuckling(self, name: str) -> BucklingAutomatedConstraint: ...
2535
2536	@overload
2537	def GetFrequency(self, id: int) -> FrequencyAutomatedConstraint: ...
2538
2539	@overload
2540	def GetFrequency(self, name: str) -> FrequencyAutomatedConstraint: ...
2541
2542	@overload
2543	def GetRotation(self, id: int) -> RotationAutomatedConstraint: ...
2544
2545	@overload
2546	def GetRotation(self, name: str) -> RotationAutomatedConstraint: ...
2547
2548	@overload
2549	def GetDisplacement(self, id: int) -> DisplacementAutomatedConstraint: ...
2550
2551	@overload
2552	def GetDisplacement(self, name: str) -> DisplacementAutomatedConstraint: ...
2553
2554	@overload
2555	def Get(self, name: str) -> AutomatedConstraint: ...
2556
2557	@overload
2558	def Get(self, id: int) -> AutomatedConstraint: ...
2559
2560	def Delete(self, item1 = None) -> bool:
2561		if isinstance(item1, int):
2562			return self._Entity.Delete(item1)
2563
2564		if isinstance(item1, str):
2565			return self._Entity.Delete(item1)
2566
2567		return self._Entity.Delete(item1)
2568
2569	def GetBuckling(self, item1 = None) -> BucklingAutomatedConstraint:
2570		if isinstance(item1, int):
2571			return BucklingAutomatedConstraint(self._Entity.GetBuckling(item1))
2572
2573		if isinstance(item1, str):
2574			return BucklingAutomatedConstraint(self._Entity.GetBuckling(item1))
2575
2576		return BucklingAutomatedConstraint(self._Entity.GetBuckling(item1))
2577
2578	def GetFrequency(self, item1 = None) -> FrequencyAutomatedConstraint:
2579		if isinstance(item1, int):
2580			return FrequencyAutomatedConstraint(self._Entity.GetFrequency(item1))
2581
2582		if isinstance(item1, str):
2583			return FrequencyAutomatedConstraint(self._Entity.GetFrequency(item1))
2584
2585		return FrequencyAutomatedConstraint(self._Entity.GetFrequency(item1))
2586
2587	def GetRotation(self, item1 = None) -> RotationAutomatedConstraint:
2588		if isinstance(item1, int):
2589			return RotationAutomatedConstraint(self._Entity.GetRotation(item1))
2590
2591		if isinstance(item1, str):
2592			return RotationAutomatedConstraint(self._Entity.GetRotation(item1))
2593
2594		return RotationAutomatedConstraint(self._Entity.GetRotation(item1))
2595
2596	def GetDisplacement(self, item1 = None) -> DisplacementAutomatedConstraint:
2597		if isinstance(item1, int):
2598			return DisplacementAutomatedConstraint(self._Entity.GetDisplacement(item1))
2599
2600		if isinstance(item1, str):
2601			return DisplacementAutomatedConstraint(self._Entity.GetDisplacement(item1))
2602
2603		return DisplacementAutomatedConstraint(self._Entity.GetDisplacement(item1))
2604
2605	def Get(self, item1 = None) -> AutomatedConstraint:
2606		if isinstance(item1, str):
2607			return AutomatedConstraint(super().Get(item1))
2608
2609		if isinstance(item1, int):
2610			return AutomatedConstraint(super().Get(item1))
2611
2612		result = self._Entity.Get(item1)
2613		thisClass = type(result).__name__
2614		givenClass = AutomatedConstraint
2615		for subclass in AutomatedConstraint.__subclasses__():
2616			if subclass.__name__ == thisClass:
2617				givenClass = subclass
2618		return givenClass(result)
2619
2620	def __getitem__(self, index: int):
2621		return self.AutomatedConstraintColList[index]
2622
2623	def __iter__(self):
2624		yield from self.AutomatedConstraintColList
2625
2626	def __len__(self):
2627		return len(self.AutomatedConstraintColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

AutomatedConstraintCol(automatedConstraintCol: HyperX.Scripting.AutomatedConstraintCol)
2484	def __init__(self, automatedConstraintCol: _api.AutomatedConstraintCol):
2485		self._Entity = automatedConstraintCol
2486		self._CollectedClass = AutomatedConstraint
AutomatedConstraintColList: tuple[AutomatedConstraint]
2488	@property
2489	def AutomatedConstraintColList(self) -> tuple[AutomatedConstraint]:
2490		return tuple([AutomatedConstraint(automatedConstraintCol) for automatedConstraintCol in self._Entity])
def AddBucklingConstraint( self, designLoads: list[str], eigenvalue: float, name: str = None) -> BucklingAutomatedConstraint:
2492	def AddBucklingConstraint(self, designLoads: list[str], eigenvalue: float, name: str = None) -> BucklingAutomatedConstraint:
2493		designLoadsList = List[str]()
2494		if designLoads is not None:
2495			for thing in designLoads:
2496				if thing is not None:
2497					designLoadsList.Add(thing)
2498		return BucklingAutomatedConstraint(self._Entity.AddBucklingConstraint(designLoadsList, eigenvalue, name))
def AddFrequencyConstraint( self, designLoads: list[str], eigenvalue: float, name: str = None) -> FrequencyAutomatedConstraint:
2500	def AddFrequencyConstraint(self, designLoads: list[str], eigenvalue: float, name: str = None) -> FrequencyAutomatedConstraint:
2501		designLoadsList = List[str]()
2502		if designLoads is not None:
2503			for thing in designLoads:
2504				if thing is not None:
2505					designLoadsList.Add(thing)
2506		return FrequencyAutomatedConstraint(self._Entity.AddFrequencyConstraint(designLoadsList, eigenvalue, name))
def AddDisplacementConstraint( self, designLoads: list[str], gridId: int, limit: float, name: str = None) -> DisplacementAutomatedConstraint:
2508	def AddDisplacementConstraint(self, designLoads: list[str], gridId: int, limit: float, name: str = None) -> DisplacementAutomatedConstraint:
2509		designLoadsList = List[str]()
2510		if designLoads is not None:
2511			for thing in designLoads:
2512				if thing is not None:
2513					designLoadsList.Add(thing)
2514		return DisplacementAutomatedConstraint(self._Entity.AddDisplacementConstraint(designLoadsList, gridId, limit, name))
def AddRotationConstraint( self, designLoads: list[str], gridId: int, limit: float, name: str = None) -> RotationAutomatedConstraint:
2516	def AddRotationConstraint(self, designLoads: list[str], gridId: int, limit: float, name: str = None) -> RotationAutomatedConstraint:
2517		designLoadsList = List[str]()
2518		if designLoads is not None:
2519			for thing in designLoads:
2520				if thing is not None:
2521					designLoadsList.Add(thing)
2522		return RotationAutomatedConstraint(self._Entity.AddRotationConstraint(designLoadsList, gridId, limit, name))
def Delete(self, item1=None) -> bool:
2560	def Delete(self, item1 = None) -> bool:
2561		if isinstance(item1, int):
2562			return self._Entity.Delete(item1)
2563
2564		if isinstance(item1, str):
2565			return self._Entity.Delete(item1)
2566
2567		return self._Entity.Delete(item1)
def GetBuckling(self, item1=None) -> BucklingAutomatedConstraint:
2569	def GetBuckling(self, item1 = None) -> BucklingAutomatedConstraint:
2570		if isinstance(item1, int):
2571			return BucklingAutomatedConstraint(self._Entity.GetBuckling(item1))
2572
2573		if isinstance(item1, str):
2574			return BucklingAutomatedConstraint(self._Entity.GetBuckling(item1))
2575
2576		return BucklingAutomatedConstraint(self._Entity.GetBuckling(item1))
def GetFrequency(self, item1=None) -> FrequencyAutomatedConstraint:
2578	def GetFrequency(self, item1 = None) -> FrequencyAutomatedConstraint:
2579		if isinstance(item1, int):
2580			return FrequencyAutomatedConstraint(self._Entity.GetFrequency(item1))
2581
2582		if isinstance(item1, str):
2583			return FrequencyAutomatedConstraint(self._Entity.GetFrequency(item1))
2584
2585		return FrequencyAutomatedConstraint(self._Entity.GetFrequency(item1))
def GetRotation(self, item1=None) -> RotationAutomatedConstraint:
2587	def GetRotation(self, item1 = None) -> RotationAutomatedConstraint:
2588		if isinstance(item1, int):
2589			return RotationAutomatedConstraint(self._Entity.GetRotation(item1))
2590
2591		if isinstance(item1, str):
2592			return RotationAutomatedConstraint(self._Entity.GetRotation(item1))
2593
2594		return RotationAutomatedConstraint(self._Entity.GetRotation(item1))
def GetDisplacement(self, item1=None) -> DisplacementAutomatedConstraint:
2596	def GetDisplacement(self, item1 = None) -> DisplacementAutomatedConstraint:
2597		if isinstance(item1, int):
2598			return DisplacementAutomatedConstraint(self._Entity.GetDisplacement(item1))
2599
2600		if isinstance(item1, str):
2601			return DisplacementAutomatedConstraint(self._Entity.GetDisplacement(item1))
2602
2603		return DisplacementAutomatedConstraint(self._Entity.GetDisplacement(item1))
def Get(self, item1=None) -> AutomatedConstraint:
2605	def Get(self, item1 = None) -> AutomatedConstraint:
2606		if isinstance(item1, str):
2607			return AutomatedConstraint(super().Get(item1))
2608
2609		if isinstance(item1, int):
2610			return AutomatedConstraint(super().Get(item1))
2611
2612		result = self._Entity.Get(item1)
2613		thisClass = type(result).__name__
2614		givenClass = AutomatedConstraint
2615		for subclass in AutomatedConstraint.__subclasses__():
2616			if subclass.__name__ == thisClass:
2617				givenClass = subclass
2618		return givenClass(result)
class ManualConstraintCol(hyperx.api.IdNameEntityCol[hyperx.api.ManualConstraint]):
2630class ManualConstraintCol(IdNameEntityCol[ManualConstraint]):
2631	def __init__(self, manualConstraintCol: _api.ManualConstraintCol):
2632		self._Entity = manualConstraintCol
2633		self._CollectedClass = ManualConstraint
2634
2635	@property
2636	def ManualConstraintColList(self) -> tuple[ManualConstraint]:
2637		return tuple([ManualConstraint(manualConstraintCol) for manualConstraintCol in self._Entity])
2638
2639	@overload
2640	def GetFrequency(self, id: int) -> FrequencyManualConstraint: ...
2641
2642	@overload
2643	def GetFrequency(self, name: str) -> FrequencyManualConstraint: ...
2644
2645	@overload
2646	def GetBuckling(self, id: int) -> BucklingManualConstraint: ...
2647
2648	@overload
2649	def GetBuckling(self, name: str) -> BucklingManualConstraint: ...
2650
2651	@overload
2652	def GetDisplacement(self, id: int) -> DisplacementManualConstraint: ...
2653
2654	@overload
2655	def GetDisplacement(self, name: str) -> DisplacementManualConstraint: ...
2656
2657	@overload
2658	def GetStaticMoment(self, id: int) -> StaticMomentManualConstraint: ...
2659
2660	@overload
2661	def GetStaticMoment(self, name: str) -> StaticMomentManualConstraint: ...
2662
2663	def AddFrequencyConstraint(self, setName: str, limit: float, name: str = None) -> FrequencyManualConstraint:
2664		return FrequencyManualConstraint(self._Entity.AddFrequencyConstraint(setName, limit, name))
2665
2666	def AddBucklingConstraint(self, setName: str, limit: float, name: str = None) -> BucklingManualConstraint:
2667		return BucklingManualConstraint(self._Entity.AddBucklingConstraint(setName, limit, name))
2668
2669	def AddStaticMomentManualConstraint(self, setName: str, limit: float, name: str = None) -> StaticMomentManualConstraint:
2670		return StaticMomentManualConstraint(self._Entity.AddStaticMomentManualConstraint(setName, limit, name))
2671
2672	def AddDisplacementConstraint(self, setName: str, gridIds: list[int], limit: float, name: str = None) -> DisplacementManualConstraint:
2673		gridIdsList = MakeCSharpIntList(gridIds)
2674		return DisplacementManualConstraint(self._Entity.AddDisplacementConstraint(setName, gridIdsList, limit, name))
2675
2676	@overload
2677	def DeleteConstraint(self, name: str) -> bool: ...
2678
2679	@overload
2680	def DeleteConstraint(self, id: int) -> bool: ...
2681
2682	@overload
2683	def Get(self, name: str) -> ManualConstraint: ...
2684
2685	@overload
2686	def Get(self, id: int) -> ManualConstraint: ...
2687
2688	def GetFrequency(self, item1 = None) -> FrequencyManualConstraint:
2689		if isinstance(item1, int):
2690			return FrequencyManualConstraint(self._Entity.GetFrequency(item1))
2691
2692		if isinstance(item1, str):
2693			return FrequencyManualConstraint(self._Entity.GetFrequency(item1))
2694
2695		return FrequencyManualConstraint(self._Entity.GetFrequency(item1))
2696
2697	def GetBuckling(self, item1 = None) -> BucklingManualConstraint:
2698		if isinstance(item1, int):
2699			return BucklingManualConstraint(self._Entity.GetBuckling(item1))
2700
2701		if isinstance(item1, str):
2702			return BucklingManualConstraint(self._Entity.GetBuckling(item1))
2703
2704		return BucklingManualConstraint(self._Entity.GetBuckling(item1))
2705
2706	def GetDisplacement(self, item1 = None) -> DisplacementManualConstraint:
2707		if isinstance(item1, int):
2708			return DisplacementManualConstraint(self._Entity.GetDisplacement(item1))
2709
2710		if isinstance(item1, str):
2711			return DisplacementManualConstraint(self._Entity.GetDisplacement(item1))
2712
2713		return DisplacementManualConstraint(self._Entity.GetDisplacement(item1))
2714
2715	def GetStaticMoment(self, item1 = None) -> StaticMomentManualConstraint:
2716		if isinstance(item1, int):
2717			return StaticMomentManualConstraint(self._Entity.GetStaticMoment(item1))
2718
2719		if isinstance(item1, str):
2720			return StaticMomentManualConstraint(self._Entity.GetStaticMoment(item1))
2721
2722		return StaticMomentManualConstraint(self._Entity.GetStaticMoment(item1))
2723
2724	def DeleteConstraint(self, item1 = None) -> bool:
2725		if isinstance(item1, str):
2726			return self._Entity.DeleteConstraint(item1)
2727
2728		if isinstance(item1, int):
2729			return self._Entity.DeleteConstraint(item1)
2730
2731		return self._Entity.DeleteConstraint(item1)
2732
2733	def Get(self, item1 = None) -> ManualConstraint:
2734		if isinstance(item1, str):
2735			return ManualConstraint(super().Get(item1))
2736
2737		if isinstance(item1, int):
2738			return ManualConstraint(super().Get(item1))
2739
2740		return ManualConstraint(self._Entity.Get(item1))
2741
2742	def __getitem__(self, index: int):
2743		return self.ManualConstraintColList[index]
2744
2745	def __iter__(self):
2746		yield from self.ManualConstraintColList
2747
2748	def __len__(self):
2749		return len(self.ManualConstraintColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

ManualConstraintCol(manualConstraintCol: HyperX.Scripting.ManualConstraintCol)
2631	def __init__(self, manualConstraintCol: _api.ManualConstraintCol):
2632		self._Entity = manualConstraintCol
2633		self._CollectedClass = ManualConstraint
ManualConstraintColList: tuple[ManualConstraint]
2635	@property
2636	def ManualConstraintColList(self) -> tuple[ManualConstraint]:
2637		return tuple([ManualConstraint(manualConstraintCol) for manualConstraintCol in self._Entity])
def GetFrequency(self, item1=None) -> FrequencyManualConstraint:
2688	def GetFrequency(self, item1 = None) -> FrequencyManualConstraint:
2689		if isinstance(item1, int):
2690			return FrequencyManualConstraint(self._Entity.GetFrequency(item1))
2691
2692		if isinstance(item1, str):
2693			return FrequencyManualConstraint(self._Entity.GetFrequency(item1))
2694
2695		return FrequencyManualConstraint(self._Entity.GetFrequency(item1))
def GetBuckling(self, item1=None) -> BucklingManualConstraint:
2697	def GetBuckling(self, item1 = None) -> BucklingManualConstraint:
2698		if isinstance(item1, int):
2699			return BucklingManualConstraint(self._Entity.GetBuckling(item1))
2700
2701		if isinstance(item1, str):
2702			return BucklingManualConstraint(self._Entity.GetBuckling(item1))
2703
2704		return BucklingManualConstraint(self._Entity.GetBuckling(item1))
def GetDisplacement(self, item1=None) -> DisplacementManualConstraint:
2706	def GetDisplacement(self, item1 = None) -> DisplacementManualConstraint:
2707		if isinstance(item1, int):
2708			return DisplacementManualConstraint(self._Entity.GetDisplacement(item1))
2709
2710		if isinstance(item1, str):
2711			return DisplacementManualConstraint(self._Entity.GetDisplacement(item1))
2712
2713		return DisplacementManualConstraint(self._Entity.GetDisplacement(item1))
def GetStaticMoment(self, item1=None) -> StaticMomentManualConstraint:
2715	def GetStaticMoment(self, item1 = None) -> StaticMomentManualConstraint:
2716		if isinstance(item1, int):
2717			return StaticMomentManualConstraint(self._Entity.GetStaticMoment(item1))
2718
2719		if isinstance(item1, str):
2720			return StaticMomentManualConstraint(self._Entity.GetStaticMoment(item1))
2721
2722		return StaticMomentManualConstraint(self._Entity.GetStaticMoment(item1))
def AddFrequencyConstraint( self, setName: str, limit: float, name: str = None) -> FrequencyManualConstraint:
2663	def AddFrequencyConstraint(self, setName: str, limit: float, name: str = None) -> FrequencyManualConstraint:
2664		return FrequencyManualConstraint(self._Entity.AddFrequencyConstraint(setName, limit, name))
def AddBucklingConstraint( self, setName: str, limit: float, name: str = None) -> BucklingManualConstraint:
2666	def AddBucklingConstraint(self, setName: str, limit: float, name: str = None) -> BucklingManualConstraint:
2667		return BucklingManualConstraint(self._Entity.AddBucklingConstraint(setName, limit, name))
def AddStaticMomentManualConstraint( self, setName: str, limit: float, name: str = None) -> StaticMomentManualConstraint:
2669	def AddStaticMomentManualConstraint(self, setName: str, limit: float, name: str = None) -> StaticMomentManualConstraint:
2670		return StaticMomentManualConstraint(self._Entity.AddStaticMomentManualConstraint(setName, limit, name))
def AddDisplacementConstraint( self, setName: str, gridIds: list[int], limit: float, name: str = None) -> DisplacementManualConstraint:
2672	def AddDisplacementConstraint(self, setName: str, gridIds: list[int], limit: float, name: str = None) -> DisplacementManualConstraint:
2673		gridIdsList = MakeCSharpIntList(gridIds)
2674		return DisplacementManualConstraint(self._Entity.AddDisplacementConstraint(setName, gridIdsList, limit, name))
def DeleteConstraint(self, item1=None) -> bool:
2724	def DeleteConstraint(self, item1 = None) -> bool:
2725		if isinstance(item1, str):
2726			return self._Entity.DeleteConstraint(item1)
2727
2728		if isinstance(item1, int):
2729			return self._Entity.DeleteConstraint(item1)
2730
2731		return self._Entity.DeleteConstraint(item1)
def Get(self, item1=None) -> ManualConstraint:
2733	def Get(self, item1 = None) -> ManualConstraint:
2734		if isinstance(item1, str):
2735			return ManualConstraint(super().Get(item1))
2736
2737		if isinstance(item1, int):
2738			return ManualConstraint(super().Get(item1))
2739
2740		return ManualConstraint(self._Entity.Get(item1))
class HyperFea:
2752class HyperFea:
2753	def __init__(self, hyperFea: _api.HyperFea):
2754		self._Entity = hyperFea
2755
2756	@property
2757	def ManualConstraints(self) -> ManualConstraintCol:
2758		result = self._Entity.ManualConstraints
2759		return ManualConstraintCol(result) if result is not None else None
2760
2761	@property
2762	def AutomatedConstraints(self) -> AutomatedConstraintCol:
2763		result = self._Entity.AutomatedConstraints
2764		return AutomatedConstraintCol(result) if result is not None else None
2765
2766	def RunIterations(self, numberOfIterations: int, startWithSizing: bool) -> None:
2767		return self._Entity.RunIterations(numberOfIterations, startWithSizing)
2768
2769	def SetupSolver(self, solverPath: str, arguments: str) -> types.SimpleStatus:
2770		return types.SimpleStatus(self._Entity.SetupSolver(solverPath, arguments))
2771
2772	def TestSolver(self) -> types.SimpleStatus:
2773		'''
2774		Test FEA solver setup.
2775		'''
2776		return types.SimpleStatus(self._Entity.TestSolver())
2777
2778	def GetSolverSetup(self) -> types.HyperFeaSolver:
2779		'''
2780		Get the current FEA solver setup.
2781		'''
2782		return types.HyperFeaSolver(self._Entity.GetSolverSetup())
HyperFea(hyperFea: HyperX.Scripting.HyperFea)
2753	def __init__(self, hyperFea: _api.HyperFea):
2754		self._Entity = hyperFea
ManualConstraints: ManualConstraintCol
2756	@property
2757	def ManualConstraints(self) -> ManualConstraintCol:
2758		result = self._Entity.ManualConstraints
2759		return ManualConstraintCol(result) if result is not None else None
AutomatedConstraints: AutomatedConstraintCol
2761	@property
2762	def AutomatedConstraints(self) -> AutomatedConstraintCol:
2763		result = self._Entity.AutomatedConstraints
2764		return AutomatedConstraintCol(result) if result is not None else None
def RunIterations(self, numberOfIterations: int, startWithSizing: bool) -> None:
2766	def RunIterations(self, numberOfIterations: int, startWithSizing: bool) -> None:
2767		return self._Entity.RunIterations(numberOfIterations, startWithSizing)
def SetupSolver(self, solverPath: str, arguments: str) -> hyperx.api.types.SimpleStatus:
2769	def SetupSolver(self, solverPath: str, arguments: str) -> types.SimpleStatus:
2770		return types.SimpleStatus(self._Entity.SetupSolver(solverPath, arguments))
def TestSolver(self) -> hyperx.api.types.SimpleStatus:
2772	def TestSolver(self) -> types.SimpleStatus:
2773		'''
2774		Test FEA solver setup.
2775		'''
2776		return types.SimpleStatus(self._Entity.TestSolver())

Test FEA solver setup.

def GetSolverSetup(self) -> hyperx.api.types.HyperFeaSolver:
2778	def GetSolverSetup(self) -> types.HyperFeaSolver:
2779		'''
2780		Get the current FEA solver setup.
2781		'''
2782		return types.HyperFeaSolver(self._Entity.GetSolverSetup())

Get the current FEA solver setup.

class FoamTemperature:
2785class FoamTemperature:
2786	'''
2787	Foam material temperature dependent properties.
2788	'''
2789	def __init__(self, foamTemperature: _api.FoamTemperature):
2790		self._Entity = foamTemperature
2791
2792	@property
2793	def Temperature(self) -> float:
2794		return self._Entity.Temperature
2795
2796	@property
2797	def Et(self) -> float:
2798		return self._Entity.Et
2799
2800	@property
2801	def Ec(self) -> float:
2802		return self._Entity.Ec
2803
2804	@property
2805	def G(self) -> float:
2806		return self._Entity.G
2807
2808	@property
2809	def Ef(self) -> float:
2810		return self._Entity.Ef
2811
2812	@property
2813	def Ftu(self) -> float:
2814		return self._Entity.Ftu
2815
2816	@property
2817	def Fcu(self) -> float:
2818		return self._Entity.Fcu
2819
2820	@property
2821	def Fsu(self) -> float:
2822		return self._Entity.Fsu
2823
2824	@property
2825	def Ffu(self) -> float:
2826		return self._Entity.Ffu
2827
2828	@property
2829	def K(self) -> float:
2830		return self._Entity.K
2831
2832	@property
2833	def C(self) -> float:
2834		return self._Entity.C
2835
2836	@Temperature.setter
2837	def Temperature(self, value: float) -> None:
2838		self._Entity.Temperature = value
2839
2840	@Et.setter
2841	def Et(self, value: float) -> None:
2842		self._Entity.Et = value
2843
2844	@Ec.setter
2845	def Ec(self, value: float) -> None:
2846		self._Entity.Ec = value
2847
2848	@G.setter
2849	def G(self, value: float) -> None:
2850		self._Entity.G = value
2851
2852	@Ef.setter
2853	def Ef(self, value: float) -> None:
2854		self._Entity.Ef = value
2855
2856	@Ftu.setter
2857	def Ftu(self, value: float) -> None:
2858		self._Entity.Ftu = value
2859
2860	@Fcu.setter
2861	def Fcu(self, value: float) -> None:
2862		self._Entity.Fcu = value
2863
2864	@Fsu.setter
2865	def Fsu(self, value: float) -> None:
2866		self._Entity.Fsu = value
2867
2868	@Ffu.setter
2869	def Ffu(self, value: float) -> None:
2870		self._Entity.Ffu = value
2871
2872	@K.setter
2873	def K(self, value: float) -> None:
2874		self._Entity.K = value
2875
2876	@C.setter
2877	def C(self, value: float) -> None:
2878		self._Entity.C = value

Foam material temperature dependent properties.

FoamTemperature(foamTemperature: HyperX.Scripting.FoamTemperature)
2789	def __init__(self, foamTemperature: _api.FoamTemperature):
2790		self._Entity = foamTemperature
Temperature: float
2792	@property
2793	def Temperature(self) -> float:
2794		return self._Entity.Temperature
Et: float
2796	@property
2797	def Et(self) -> float:
2798		return self._Entity.Et
Ec: float
2800	@property
2801	def Ec(self) -> float:
2802		return self._Entity.Ec
G: float
2804	@property
2805	def G(self) -> float:
2806		return self._Entity.G
Ef: float
2808	@property
2809	def Ef(self) -> float:
2810		return self._Entity.Ef
Ftu: float
2812	@property
2813	def Ftu(self) -> float:
2814		return self._Entity.Ftu
Fcu: float
2816	@property
2817	def Fcu(self) -> float:
2818		return self._Entity.Fcu
Fsu: float
2820	@property
2821	def Fsu(self) -> float:
2822		return self._Entity.Fsu
Ffu: float
2824	@property
2825	def Ffu(self) -> float:
2826		return self._Entity.Ffu
K: float
2828	@property
2829	def K(self) -> float:
2830		return self._Entity.K
C: float
2832	@property
2833	def C(self) -> float:
2834		return self._Entity.C
class Foam:
2881class Foam:
2882	'''
2883	Foam material.
2884	'''
2885	def __init__(self, foam: _api.Foam):
2886		self._Entity = foam
2887
2888	@property
2889	def MaterialFamilyName(self) -> str:
2890		return self._Entity.MaterialFamilyName
2891
2892	@property
2893	def Id(self) -> int:
2894		return self._Entity.Id
2895
2896	@property
2897	def CreationDate(self) -> DateTime:
2898		return self._Entity.CreationDate
2899
2900	@property
2901	def ModificationDate(self) -> DateTime:
2902		return self._Entity.ModificationDate
2903
2904	@property
2905	def Name(self) -> str:
2906		return self._Entity.Name
2907
2908	@property
2909	def Wet(self) -> bool:
2910		return self._Entity.Wet
2911
2912	@property
2913	def Density(self) -> float:
2914		return self._Entity.Density
2915
2916	@property
2917	def Form(self) -> str:
2918		return self._Entity.Form
2919
2920	@property
2921	def Specification(self) -> str:
2922		return self._Entity.Specification
2923
2924	@property
2925	def MaterialDescription(self) -> str:
2926		return self._Entity.MaterialDescription
2927
2928	@property
2929	def UserNote(self) -> str:
2930		return self._Entity.UserNote
2931
2932	@property
2933	def FemMaterialId(self) -> int:
2934		return self._Entity.FemMaterialId
2935
2936	@property
2937	def Cost(self) -> float:
2938		return self._Entity.Cost
2939
2940	@property
2941	def BucklingStiffnessKnockdown(self) -> float:
2942		return self._Entity.BucklingStiffnessKnockdown
2943
2944	@property
2945	def Absorption(self) -> float:
2946		return self._Entity.Absorption
2947
2948	@property
2949	def Manufacturer(self) -> str:
2950		return self._Entity.Manufacturer
2951
2952	@property
2953	def FoamTemperatureProperties(self) -> list[FoamTemperature]:
2954		return [FoamTemperature(foamTemperature) for foamTemperature in self._Entity.FoamTemperatureProperties]
2955
2956	@MaterialFamilyName.setter
2957	def MaterialFamilyName(self, value: str) -> None:
2958		self._Entity.MaterialFamilyName = value
2959
2960	@Name.setter
2961	def Name(self, value: str) -> None:
2962		self._Entity.Name = value
2963
2964	@Wet.setter
2965	def Wet(self, value: bool) -> None:
2966		self._Entity.Wet = value
2967
2968	@Density.setter
2969	def Density(self, value: float) -> None:
2970		self._Entity.Density = value
2971
2972	@Form.setter
2973	def Form(self, value: str) -> None:
2974		self._Entity.Form = value
2975
2976	@Specification.setter
2977	def Specification(self, value: str) -> None:
2978		self._Entity.Specification = value
2979
2980	@MaterialDescription.setter
2981	def MaterialDescription(self, value: str) -> None:
2982		self._Entity.MaterialDescription = value
2983
2984	@UserNote.setter
2985	def UserNote(self, value: str) -> None:
2986		self._Entity.UserNote = value
2987
2988	@FemMaterialId.setter
2989	def FemMaterialId(self, value: int) -> None:
2990		self._Entity.FemMaterialId = value
2991
2992	@Cost.setter
2993	def Cost(self, value: float) -> None:
2994		self._Entity.Cost = value
2995
2996	@BucklingStiffnessKnockdown.setter
2997	def BucklingStiffnessKnockdown(self, value: float) -> None:
2998		self._Entity.BucklingStiffnessKnockdown = value
2999
3000	@Absorption.setter
3001	def Absorption(self, value: float) -> None:
3002		self._Entity.Absorption = value
3003
3004	@Manufacturer.setter
3005	def Manufacturer(self, value: str) -> None:
3006		self._Entity.Manufacturer = value
3007
3008	def AddTemperatureProperty(self, temperature: float, et: float, ec: float, g: float, ftu: float, fcu: float, fsu: float, ef: float = None, ffu: float = None, k: float = None, c: float = None) -> FoamTemperature:
3009		return FoamTemperature(self._Entity.AddTemperatureProperty(temperature, et, ec, g, ftu, fcu, fsu, ef, ffu, k, c))
3010
3011	def DeleteTemperatureProperty(self, temperature: float) -> bool:
3012		return self._Entity.DeleteTemperatureProperty(temperature)
3013
3014	def GetTemperature(self, lookupTemperature: float) -> FoamTemperature:
3015		return FoamTemperature(self._Entity.GetTemperature(lookupTemperature))
3016
3017	def Save(self) -> None:
3018		'''
3019		Save any changes to this foam material to the database.
3020		'''
3021		return self._Entity.Save()

Foam material.

Foam(foam: HyperX.Scripting.Foam)
2885	def __init__(self, foam: _api.Foam):
2886		self._Entity = foam
MaterialFamilyName: str
2888	@property
2889	def MaterialFamilyName(self) -> str:
2890		return self._Entity.MaterialFamilyName
Id: int
2892	@property
2893	def Id(self) -> int:
2894		return self._Entity.Id
CreationDate: System.DateTime
2896	@property
2897	def CreationDate(self) -> DateTime:
2898		return self._Entity.CreationDate
ModificationDate: System.DateTime
2900	@property
2901	def ModificationDate(self) -> DateTime:
2902		return self._Entity.ModificationDate
Name: str
2904	@property
2905	def Name(self) -> str:
2906		return self._Entity.Name
Wet: bool
2908	@property
2909	def Wet(self) -> bool:
2910		return self._Entity.Wet
Density: float
2912	@property
2913	def Density(self) -> float:
2914		return self._Entity.Density
Form: str
2916	@property
2917	def Form(self) -> str:
2918		return self._Entity.Form
Specification: str
2920	@property
2921	def Specification(self) -> str:
2922		return self._Entity.Specification
MaterialDescription: str
2924	@property
2925	def MaterialDescription(self) -> str:
2926		return self._Entity.MaterialDescription
UserNote: str
2928	@property
2929	def UserNote(self) -> str:
2930		return self._Entity.UserNote
FemMaterialId: int
2932	@property
2933	def FemMaterialId(self) -> int:
2934		return self._Entity.FemMaterialId
Cost: float
2936	@property
2937	def Cost(self) -> float:
2938		return self._Entity.Cost
BucklingStiffnessKnockdown: float
2940	@property
2941	def BucklingStiffnessKnockdown(self) -> float:
2942		return self._Entity.BucklingStiffnessKnockdown
Absorption: float
2944	@property
2945	def Absorption(self) -> float:
2946		return self._Entity.Absorption
Manufacturer: str
2948	@property
2949	def Manufacturer(self) -> str:
2950		return self._Entity.Manufacturer
FoamTemperatureProperties: list[FoamTemperature]
2952	@property
2953	def FoamTemperatureProperties(self) -> list[FoamTemperature]:
2954		return [FoamTemperature(foamTemperature) for foamTemperature in self._Entity.FoamTemperatureProperties]
def AddTemperatureProperty( self, temperature: float, et: float, ec: float, g: float, ftu: float, fcu: float, fsu: float, ef: float = None, ffu: float = None, k: float = None, c: float = None) -> FoamTemperature:
3008	def AddTemperatureProperty(self, temperature: float, et: float, ec: float, g: float, ftu: float, fcu: float, fsu: float, ef: float = None, ffu: float = None, k: float = None, c: float = None) -> FoamTemperature:
3009		return FoamTemperature(self._Entity.AddTemperatureProperty(temperature, et, ec, g, ftu, fcu, fsu, ef, ffu, k, c))
def DeleteTemperatureProperty(self, temperature: float) -> bool:
3011	def DeleteTemperatureProperty(self, temperature: float) -> bool:
3012		return self._Entity.DeleteTemperatureProperty(temperature)
def GetTemperature(self, lookupTemperature: float) -> FoamTemperature:
3014	def GetTemperature(self, lookupTemperature: float) -> FoamTemperature:
3015		return FoamTemperature(self._Entity.GetTemperature(lookupTemperature))
def Save(self) -> None:
3017	def Save(self) -> None:
3018		'''
3019		Save any changes to this foam material to the database.
3020		'''
3021		return self._Entity.Save()

Save any changes to this foam material to the database.

class HoneycombTemperature:
3024class HoneycombTemperature:
3025	'''
3026	Honeycomb material temperature dependent properties.
3027	'''
3028	def __init__(self, honeycombTemperature: _api.HoneycombTemperature):
3029		self._Entity = honeycombTemperature
3030
3031	@property
3032	def Temperature(self) -> float:
3033		return self._Entity.Temperature
3034
3035	@property
3036	def Et(self) -> float:
3037		return self._Entity.Et
3038
3039	@property
3040	def Ec(self) -> float:
3041		return self._Entity.Ec
3042
3043	@property
3044	def Gw(self) -> float:
3045		return self._Entity.Gw
3046
3047	@property
3048	def Gl(self) -> float:
3049		return self._Entity.Gl
3050
3051	@property
3052	def Ftu(self) -> float:
3053		return self._Entity.Ftu
3054
3055	@property
3056	def Fcus(self) -> float:
3057		return self._Entity.Fcus
3058
3059	@property
3060	def Fcub(self) -> float:
3061		return self._Entity.Fcub
3062
3063	@property
3064	def Fcuc(self) -> float:
3065		return self._Entity.Fcuc
3066
3067	@property
3068	def Fsuw(self) -> float:
3069		return self._Entity.Fsuw
3070
3071	@property
3072	def Fsul(self) -> float:
3073		return self._Entity.Fsul
3074
3075	@property
3076	def SScfl(self) -> float:
3077		return self._Entity.SScfl
3078
3079	@property
3080	def SScfh(self) -> float:
3081		return self._Entity.SScfh
3082
3083	@property
3084	def Kl(self) -> float:
3085		return self._Entity.Kl
3086
3087	@property
3088	def Kw(self) -> float:
3089		return self._Entity.Kw
3090
3091	@property
3092	def Kt(self) -> float:
3093		return self._Entity.Kt
3094
3095	@property
3096	def C(self) -> float:
3097		return self._Entity.C
3098
3099	@Temperature.setter
3100	def Temperature(self, value: float) -> None:
3101		self._Entity.Temperature = value
3102
3103	@Et.setter
3104	def Et(self, value: float) -> None:
3105		self._Entity.Et = value
3106
3107	@Ec.setter
3108	def Ec(self, value: float) -> None:
3109		self._Entity.Ec = value
3110
3111	@Gw.setter
3112	def Gw(self, value: float) -> None:
3113		self._Entity.Gw = value
3114
3115	@Gl.setter
3116	def Gl(self, value: float) -> None:
3117		self._Entity.Gl = value
3118
3119	@Ftu.setter
3120	def Ftu(self, value: float) -> None:
3121		self._Entity.Ftu = value
3122
3123	@Fcus.setter
3124	def Fcus(self, value: float) -> None:
3125		self._Entity.Fcus = value
3126
3127	@Fcub.setter
3128	def Fcub(self, value: float) -> None:
3129		self._Entity.Fcub = value
3130
3131	@Fcuc.setter
3132	def Fcuc(self, value: float) -> None:
3133		self._Entity.Fcuc = value
3134
3135	@Fsuw.setter
3136	def Fsuw(self, value: float) -> None:
3137		self._Entity.Fsuw = value
3138
3139	@Fsul.setter
3140	def Fsul(self, value: float) -> None:
3141		self._Entity.Fsul = value
3142
3143	@SScfl.setter
3144	def SScfl(self, value: float) -> None:
3145		self._Entity.SScfl = value
3146
3147	@SScfh.setter
3148	def SScfh(self, value: float) -> None:
3149		self._Entity.SScfh = value
3150
3151	@Kl.setter
3152	def Kl(self, value: float) -> None:
3153		self._Entity.Kl = value
3154
3155	@Kw.setter
3156	def Kw(self, value: float) -> None:
3157		self._Entity.Kw = value
3158
3159	@Kt.setter
3160	def Kt(self, value: float) -> None:
3161		self._Entity.Kt = value
3162
3163	@C.setter
3164	def C(self, value: float) -> None:
3165		self._Entity.C = value

Honeycomb material temperature dependent properties.

HoneycombTemperature(honeycombTemperature: HyperX.Scripting.HoneycombTemperature)
3028	def __init__(self, honeycombTemperature: _api.HoneycombTemperature):
3029		self._Entity = honeycombTemperature
Temperature: float
3031	@property
3032	def Temperature(self) -> float:
3033		return self._Entity.Temperature
Et: float
3035	@property
3036	def Et(self) -> float:
3037		return self._Entity.Et
Ec: float
3039	@property
3040	def Ec(self) -> float:
3041		return self._Entity.Ec
Gw: float
3043	@property
3044	def Gw(self) -> float:
3045		return self._Entity.Gw
Gl: float
3047	@property
3048	def Gl(self) -> float:
3049		return self._Entity.Gl
Ftu: float
3051	@property
3052	def Ftu(self) -> float:
3053		return self._Entity.Ftu
Fcus: float
3055	@property
3056	def Fcus(self) -> float:
3057		return self._Entity.Fcus
Fcub: float
3059	@property
3060	def Fcub(self) -> float:
3061		return self._Entity.Fcub
Fcuc: float
3063	@property
3064	def Fcuc(self) -> float:
3065		return self._Entity.Fcuc
Fsuw: float
3067	@property
3068	def Fsuw(self) -> float:
3069		return self._Entity.Fsuw
Fsul: float
3071	@property
3072	def Fsul(self) -> float:
3073		return self._Entity.Fsul
SScfl: float
3075	@property
3076	def SScfl(self) -> float:
3077		return self._Entity.SScfl
SScfh: float
3079	@property
3080	def SScfh(self) -> float:
3081		return self._Entity.SScfh
Kl: float
3083	@property
3084	def Kl(self) -> float:
3085		return self._Entity.Kl
Kw: float
3087	@property
3088	def Kw(self) -> float:
3089		return self._Entity.Kw
Kt: float
3091	@property
3092	def Kt(self) -> float:
3093		return self._Entity.Kt
C: float
3095	@property
3096	def C(self) -> float:
3097		return self._Entity.C
class Honeycomb:
3168class Honeycomb:
3169	'''
3170	Honeycomb material.
3171	'''
3172	def __init__(self, honeycomb: _api.Honeycomb):
3173		self._Entity = honeycomb
3174
3175	@property
3176	def MaterialFamilyName(self) -> str:
3177		return self._Entity.MaterialFamilyName
3178
3179	@property
3180	def Id(self) -> int:
3181		return self._Entity.Id
3182
3183	@property
3184	def CreationDate(self) -> DateTime:
3185		return self._Entity.CreationDate
3186
3187	@property
3188	def ModificationDate(self) -> DateTime:
3189		return self._Entity.ModificationDate
3190
3191	@property
3192	def Name(self) -> str:
3193		return self._Entity.Name
3194
3195	@property
3196	def Wet(self) -> bool:
3197		return self._Entity.Wet
3198
3199	@property
3200	def Density(self) -> float:
3201		return self._Entity.Density
3202
3203	@property
3204	def Form(self) -> str:
3205		return self._Entity.Form
3206
3207	@property
3208	def Specification(self) -> str:
3209		return self._Entity.Specification
3210
3211	@property
3212	def MaterialDescription(self) -> str:
3213		return self._Entity.MaterialDescription
3214
3215	@property
3216	def UserNote(self) -> str:
3217		return self._Entity.UserNote
3218
3219	@property
3220	def FemMaterialId(self) -> int:
3221		return self._Entity.FemMaterialId
3222
3223	@property
3224	def Cost(self) -> float:
3225		return self._Entity.Cost
3226
3227	@property
3228	def CellSize(self) -> float:
3229		return self._Entity.CellSize
3230
3231	@property
3232	def Manufacturer(self) -> str:
3233		return self._Entity.Manufacturer
3234
3235	@property
3236	def HoneycombTemperatureProperties(self) -> list[HoneycombTemperature]:
3237		return [HoneycombTemperature(honeycombTemperature) for honeycombTemperature in self._Entity.HoneycombTemperatureProperties]
3238
3239	@MaterialFamilyName.setter
3240	def MaterialFamilyName(self, value: str) -> None:
3241		self._Entity.MaterialFamilyName = value
3242
3243	@Name.setter
3244	def Name(self, value: str) -> None:
3245		self._Entity.Name = value
3246
3247	@Wet.setter
3248	def Wet(self, value: bool) -> None:
3249		self._Entity.Wet = value
3250
3251	@Density.setter
3252	def Density(self, value: float) -> None:
3253		self._Entity.Density = value
3254
3255	@Form.setter
3256	def Form(self, value: str) -> None:
3257		self._Entity.Form = value
3258
3259	@Specification.setter
3260	def Specification(self, value: str) -> None:
3261		self._Entity.Specification = value
3262
3263	@MaterialDescription.setter
3264	def MaterialDescription(self, value: str) -> None:
3265		self._Entity.MaterialDescription = value
3266
3267	@UserNote.setter
3268	def UserNote(self, value: str) -> None:
3269		self._Entity.UserNote = value
3270
3271	@FemMaterialId.setter
3272	def FemMaterialId(self, value: int) -> None:
3273		self._Entity.FemMaterialId = value
3274
3275	@Cost.setter
3276	def Cost(self, value: float) -> None:
3277		self._Entity.Cost = value
3278
3279	@CellSize.setter
3280	def CellSize(self, value: float) -> None:
3281		self._Entity.CellSize = value
3282
3283	@Manufacturer.setter
3284	def Manufacturer(self, value: str) -> None:
3285		self._Entity.Manufacturer = value
3286
3287	def AddTemperatureProperty(self, temperature: float, et: float, ec: float, gw: float, gl: float, ftu: float, fcus: float, fcub: float, fcuc: float, fsuw: float, fsul: float, sScfl: float = None, sScfh: float = None, k1: float = None, k2: float = None, k3: float = None, c: float = None) -> HoneycombTemperature:
3288		return HoneycombTemperature(self._Entity.AddTemperatureProperty(temperature, et, ec, gw, gl, ftu, fcus, fcub, fcuc, fsuw, fsul, sScfl, sScfh, k1, k2, k3, c))
3289
3290	def DeleteTemperatureProperty(self, temperature: float) -> bool:
3291		return self._Entity.DeleteTemperatureProperty(temperature)
3292
3293	def GetTemperature(self, lookupTemperature: float) -> HoneycombTemperature:
3294		return HoneycombTemperature(self._Entity.GetTemperature(lookupTemperature))
3295
3296	def Save(self) -> None:
3297		'''
3298		Save any changes to this honeycomb material to the database.
3299		'''
3300		return self._Entity.Save()

Honeycomb material.

Honeycomb(honeycomb: HyperX.Scripting.Honeycomb)
3172	def __init__(self, honeycomb: _api.Honeycomb):
3173		self._Entity = honeycomb
MaterialFamilyName: str
3175	@property
3176	def MaterialFamilyName(self) -> str:
3177		return self._Entity.MaterialFamilyName
Id: int
3179	@property
3180	def Id(self) -> int:
3181		return self._Entity.Id
CreationDate: System.DateTime
3183	@property
3184	def CreationDate(self) -> DateTime:
3185		return self._Entity.CreationDate
ModificationDate: System.DateTime
3187	@property
3188	def ModificationDate(self) -> DateTime:
3189		return self._Entity.ModificationDate
Name: str
3191	@property
3192	def Name(self) -> str:
3193		return self._Entity.Name
Wet: bool
3195	@property
3196	def Wet(self) -> bool:
3197		return self._Entity.Wet
Density: float
3199	@property
3200	def Density(self) -> float:
3201		return self._Entity.Density
Form: str
3203	@property
3204	def Form(self) -> str:
3205		return self._Entity.Form
Specification: str
3207	@property
3208	def Specification(self) -> str:
3209		return self._Entity.Specification
MaterialDescription: str
3211	@property
3212	def MaterialDescription(self) -> str:
3213		return self._Entity.MaterialDescription
UserNote: str
3215	@property
3216	def UserNote(self) -> str:
3217		return self._Entity.UserNote
FemMaterialId: int
3219	@property
3220	def FemMaterialId(self) -> int:
3221		return self._Entity.FemMaterialId
Cost: float
3223	@property
3224	def Cost(self) -> float:
3225		return self._Entity.Cost
CellSize: float
3227	@property
3228	def CellSize(self) -> float:
3229		return self._Entity.CellSize
Manufacturer: str
3231	@property
3232	def Manufacturer(self) -> str:
3233		return self._Entity.Manufacturer
HoneycombTemperatureProperties: list[HoneycombTemperature]
3235	@property
3236	def HoneycombTemperatureProperties(self) -> list[HoneycombTemperature]:
3237		return [HoneycombTemperature(honeycombTemperature) for honeycombTemperature in self._Entity.HoneycombTemperatureProperties]
def AddTemperatureProperty( self, temperature: float, et: float, ec: float, gw: float, gl: float, ftu: float, fcus: float, fcub: float, fcuc: float, fsuw: float, fsul: float, sScfl: float = None, sScfh: float = None, k1: float = None, k2: float = None, k3: float = None, c: float = None) -> HoneycombTemperature:
3287	def AddTemperatureProperty(self, temperature: float, et: float, ec: float, gw: float, gl: float, ftu: float, fcus: float, fcub: float, fcuc: float, fsuw: float, fsul: float, sScfl: float = None, sScfh: float = None, k1: float = None, k2: float = None, k3: float = None, c: float = None) -> HoneycombTemperature:
3288		return HoneycombTemperature(self._Entity.AddTemperatureProperty(temperature, et, ec, gw, gl, ftu, fcus, fcub, fcuc, fsuw, fsul, sScfl, sScfh, k1, k2, k3, c))
def DeleteTemperatureProperty(self, temperature: float) -> bool:
3290	def DeleteTemperatureProperty(self, temperature: float) -> bool:
3291		return self._Entity.DeleteTemperatureProperty(temperature)
def GetTemperature(self, lookupTemperature: float) -> HoneycombTemperature:
3293	def GetTemperature(self, lookupTemperature: float) -> HoneycombTemperature:
3294		return HoneycombTemperature(self._Entity.GetTemperature(lookupTemperature))
def Save(self) -> None:
3296	def Save(self) -> None:
3297		'''
3298		Save any changes to this honeycomb material to the database.
3299		'''
3300		return self._Entity.Save()

Save any changes to this honeycomb material to the database.

class IsotropicTemperature:
3303class IsotropicTemperature:
3304	'''
3305	Isotropic material temperature dependent properties.
3306	'''
3307	def __init__(self, isotropicTemperature: _api.IsotropicTemperature):
3308		self._Entity = isotropicTemperature
3309
3310	@property
3311	def Temperature(self) -> float:
3312		return self._Entity.Temperature
3313
3314	@property
3315	def Et(self) -> float:
3316		return self._Entity.Et
3317
3318	@property
3319	def Ec(self) -> float:
3320		return self._Entity.Ec
3321
3322	@property
3323	def G(self) -> float:
3324		return self._Entity.G
3325
3326	@property
3327	def n(self) -> float:
3328		return self._Entity.n
3329
3330	@property
3331	def F02(self) -> float:
3332		return self._Entity.F02
3333
3334	@property
3335	def FtuL(self) -> float:
3336		return self._Entity.FtuL
3337
3338	@property
3339	def FtyL(self) -> float:
3340		return self._Entity.FtyL
3341
3342	@property
3343	def FcyL(self) -> float:
3344		return self._Entity.FcyL
3345
3346	@property
3347	def FtuLT(self) -> float:
3348		return self._Entity.FtuLT
3349
3350	@property
3351	def FtyLT(self) -> float:
3352		return self._Entity.FtyLT
3353
3354	@property
3355	def FcyLT(self) -> float:
3356		return self._Entity.FcyLT
3357
3358	@property
3359	def Fsu(self) -> float:
3360		return self._Entity.Fsu
3361
3362	@property
3363	def Fbru15(self) -> float:
3364		return self._Entity.Fbru15
3365
3366	@property
3367	def Fbry15(self) -> float:
3368		return self._Entity.Fbry15
3369
3370	@property
3371	def Fbru20(self) -> float:
3372		return self._Entity.Fbru20
3373
3374	@property
3375	def Fbry20(self) -> float:
3376		return self._Entity.Fbry20
3377
3378	@property
3379	def alpha(self) -> float:
3380		return self._Entity.alpha
3381
3382	@property
3383	def K(self) -> float:
3384		return self._Entity.K
3385
3386	@property
3387	def C(self) -> float:
3388		return self._Entity.C
3389
3390	@property
3391	def etyL(self) -> float:
3392		return self._Entity.etyL
3393
3394	@property
3395	def ecyL(self) -> float:
3396		return self._Entity.ecyL
3397
3398	@property
3399	def etyLT(self) -> float:
3400		return self._Entity.etyLT
3401
3402	@property
3403	def ecyLT(self) -> float:
3404		return self._Entity.ecyLT
3405
3406	@property
3407	def esu(self) -> float:
3408		return self._Entity.esu
3409
3410	@property
3411	def Fpadh(self) -> float:
3412		return self._Entity.Fpadh
3413
3414	@property
3415	def Fsadh(self) -> float:
3416		return self._Entity.Fsadh
3417
3418	@property
3419	def esadh(self) -> float:
3420		return self._Entity.esadh
3421
3422	@property
3423	def cd(self) -> float:
3424		return self._Entity.cd
3425
3426	@property
3427	def Ffwt(self) -> float:
3428		return self._Entity.Ffwt
3429
3430	@property
3431	def Ffxz(self) -> float:
3432		return self._Entity.Ffxz
3433
3434	@property
3435	def Ffyz(self) -> float:
3436		return self._Entity.Ffyz
3437
3438	@property
3439	def FtFatigue(self) -> float:
3440		return self._Entity.FtFatigue
3441
3442	@property
3443	def FcFatigue(self) -> float:
3444		return self._Entity.FcFatigue
3445
3446	@Temperature.setter
3447	def Temperature(self, value: float) -> None:
3448		self._Entity.Temperature = value
3449
3450	@Et.setter
3451	def Et(self, value: float) -> None:
3452		self._Entity.Et = value
3453
3454	@Ec.setter
3455	def Ec(self, value: float) -> None:
3456		self._Entity.Ec = value
3457
3458	@G.setter
3459	def G(self, value: float) -> None:
3460		self._Entity.G = value
3461
3462	@n.setter
3463	def n(self, value: float) -> None:
3464		self._Entity.n = value
3465
3466	@F02.setter
3467	def F02(self, value: float) -> None:
3468		self._Entity.F02 = value
3469
3470	@FtuL.setter
3471	def FtuL(self, value: float) -> None:
3472		self._Entity.FtuL = value
3473
3474	@FtyL.setter
3475	def FtyL(self, value: float) -> None:
3476		self._Entity.FtyL = value
3477
3478	@FcyL.setter
3479	def FcyL(self, value: float) -> None:
3480		self._Entity.FcyL = value
3481
3482	@FtuLT.setter
3483	def FtuLT(self, value: float) -> None:
3484		self._Entity.FtuLT = value
3485
3486	@FtyLT.setter
3487	def FtyLT(self, value: float) -> None:
3488		self._Entity.FtyLT = value
3489
3490	@FcyLT.setter
3491	def FcyLT(self, value: float) -> None:
3492		self._Entity.FcyLT = value
3493
3494	@Fsu.setter
3495	def Fsu(self, value: float) -> None:
3496		self._Entity.Fsu = value
3497
3498	@Fbru15.setter
3499	def Fbru15(self, value: float) -> None:
3500		self._Entity.Fbru15 = value
3501
3502	@Fbry15.setter
3503	def Fbry15(self, value: float) -> None:
3504		self._Entity.Fbry15 = value
3505
3506	@Fbru20.setter
3507	def Fbru20(self, value: float) -> None:
3508		self._Entity.Fbru20 = value
3509
3510	@Fbry20.setter
3511	def Fbry20(self, value: float) -> None:
3512		self._Entity.Fbry20 = value
3513
3514	@alpha.setter
3515	def alpha(self, value: float) -> None:
3516		self._Entity.alpha = value
3517
3518	@K.setter
3519	def K(self, value: float) -> None:
3520		self._Entity.K = value
3521
3522	@C.setter
3523	def C(self, value: float) -> None:
3524		self._Entity.C = value
3525
3526	@etyL.setter
3527	def etyL(self, value: float) -> None:
3528		self._Entity.etyL = value
3529
3530	@ecyL.setter
3531	def ecyL(self, value: float) -> None:
3532		self._Entity.ecyL = value
3533
3534	@etyLT.setter
3535	def etyLT(self, value: float) -> None:
3536		self._Entity.etyLT = value
3537
3538	@ecyLT.setter
3539	def ecyLT(self, value: float) -> None:
3540		self._Entity.ecyLT = value
3541
3542	@esu.setter
3543	def esu(self, value: float) -> None:
3544		self._Entity.esu = value
3545
3546	@Fpadh.setter
3547	def Fpadh(self, value: float) -> None:
3548		self._Entity.Fpadh = value
3549
3550	@Fsadh.setter
3551	def Fsadh(self, value: float) -> None:
3552		self._Entity.Fsadh = value
3553
3554	@esadh.setter
3555	def esadh(self, value: float) -> None:
3556		self._Entity.esadh = value
3557
3558	@cd.setter
3559	def cd(self, value: float) -> None:
3560		self._Entity.cd = value
3561
3562	@Ffwt.setter
3563	def Ffwt(self, value: float) -> None:
3564		self._Entity.Ffwt = value
3565
3566	@Ffxz.setter
3567	def Ffxz(self, value: float) -> None:
3568		self._Entity.Ffxz = value
3569
3570	@Ffyz.setter
3571	def Ffyz(self, value: float) -> None:
3572		self._Entity.Ffyz = value
3573
3574	@FtFatigue.setter
3575	def FtFatigue(self, value: float) -> None:
3576		self._Entity.FtFatigue = value
3577
3578	@FcFatigue.setter
3579	def FcFatigue(self, value: float) -> None:
3580		self._Entity.FcFatigue = value

Isotropic material temperature dependent properties.

IsotropicTemperature(isotropicTemperature: HyperX.Scripting.IsotropicTemperature)
3307	def __init__(self, isotropicTemperature: _api.IsotropicTemperature):
3308		self._Entity = isotropicTemperature
Temperature: float
3310	@property
3311	def Temperature(self) -> float:
3312		return self._Entity.Temperature
Et: float
3314	@property
3315	def Et(self) -> float:
3316		return self._Entity.Et
Ec: float
3318	@property
3319	def Ec(self) -> float:
3320		return self._Entity.Ec
G: float
3322	@property
3323	def G(self) -> float:
3324		return self._Entity.G
n: float
3326	@property
3327	def n(self) -> float:
3328		return self._Entity.n
F02: float
3330	@property
3331	def F02(self) -> float:
3332		return self._Entity.F02
FtuL: float
3334	@property
3335	def FtuL(self) -> float:
3336		return self._Entity.FtuL
FtyL: float
3338	@property
3339	def FtyL(self) -> float:
3340		return self._Entity.FtyL
FcyL: float
3342	@property
3343	def FcyL(self) -> float:
3344		return self._Entity.FcyL
FtuLT: float
3346	@property
3347	def FtuLT(self) -> float:
3348		return self._Entity.FtuLT
FtyLT: float
3350	@property
3351	def FtyLT(self) -> float:
3352		return self._Entity.FtyLT
FcyLT: float
3354	@property
3355	def FcyLT(self) -> float:
3356		return self._Entity.FcyLT
Fsu: float
3358	@property
3359	def Fsu(self) -> float:
3360		return self._Entity.Fsu
Fbru15: float
3362	@property
3363	def Fbru15(self) -> float:
3364		return self._Entity.Fbru15
Fbry15: float
3366	@property
3367	def Fbry15(self) -> float:
3368		return self._Entity.Fbry15
Fbru20: float
3370	@property
3371	def Fbru20(self) -> float:
3372		return self._Entity.Fbru20
Fbry20: float
3374	@property
3375	def Fbry20(self) -> float:
3376		return self._Entity.Fbry20
alpha: float
3378	@property
3379	def alpha(self) -> float:
3380		return self._Entity.alpha
K: float
3382	@property
3383	def K(self) -> float:
3384		return self._Entity.K
C: float
3386	@property
3387	def C(self) -> float:
3388		return self._Entity.C
etyL: float
3390	@property
3391	def etyL(self) -> float:
3392		return self._Entity.etyL
ecyL: float
3394	@property
3395	def ecyL(self) -> float:
3396		return self._Entity.ecyL
etyLT: float
3398	@property
3399	def etyLT(self) -> float:
3400		return self._Entity.etyLT
ecyLT: float
3402	@property
3403	def ecyLT(self) -> float:
3404		return self._Entity.ecyLT
esu: float
3406	@property
3407	def esu(self) -> float:
3408		return self._Entity.esu
Fpadh: float
3410	@property
3411	def Fpadh(self) -> float:
3412		return self._Entity.Fpadh
Fsadh: float
3414	@property
3415	def Fsadh(self) -> float:
3416		return self._Entity.Fsadh
esadh: float
3418	@property
3419	def esadh(self) -> float:
3420		return self._Entity.esadh
cd: float
3422	@property
3423	def cd(self) -> float:
3424		return self._Entity.cd
Ffwt: float
3426	@property
3427	def Ffwt(self) -> float:
3428		return self._Entity.Ffwt
Ffxz: float
3430	@property
3431	def Ffxz(self) -> float:
3432		return self._Entity.Ffxz
Ffyz: float
3434	@property
3435	def Ffyz(self) -> float:
3436		return self._Entity.Ffyz
FtFatigue: float
3438	@property
3439	def FtFatigue(self) -> float:
3440		return self._Entity.FtFatigue
FcFatigue: float
3442	@property
3443	def FcFatigue(self) -> float:
3444		return self._Entity.FcFatigue
class Isotropic:
3583class Isotropic:
3584	'''
3585	Isotropic material.
3586	'''
3587	def __init__(self, isotropic: _api.Isotropic):
3588		self._Entity = isotropic
3589
3590	@property
3591	def MaterialFamilyName(self) -> str:
3592		return self._Entity.MaterialFamilyName
3593
3594	@property
3595	def Id(self) -> int:
3596		return self._Entity.Id
3597
3598	@property
3599	def CreationDate(self) -> DateTime:
3600		return self._Entity.CreationDate
3601
3602	@property
3603	def ModificationDate(self) -> DateTime:
3604		return self._Entity.ModificationDate
3605
3606	@property
3607	def Name(self) -> str:
3608		return self._Entity.Name
3609
3610	@property
3611	def Form(self) -> str:
3612		return self._Entity.Form
3613
3614	@property
3615	def Specification(self) -> str:
3616		return self._Entity.Specification
3617
3618	@property
3619	def Temper(self) -> str:
3620		return self._Entity.Temper
3621
3622	@property
3623	def Basis(self) -> str:
3624		return self._Entity.Basis
3625
3626	@property
3627	def Density(self) -> float:
3628		return self._Entity.Density
3629
3630	@property
3631	def MaterialDescription(self) -> str:
3632		return self._Entity.MaterialDescription
3633
3634	@property
3635	def UserNote(self) -> str:
3636		return self._Entity.UserNote
3637
3638	@property
3639	def FemMaterialId(self) -> int:
3640		return self._Entity.FemMaterialId
3641
3642	@property
3643	def Cost(self) -> float:
3644		return self._Entity.Cost
3645
3646	@property
3647	def BucklingStiffnessKnockdown(self) -> float:
3648		return self._Entity.BucklingStiffnessKnockdown
3649
3650	@property
3651	def IsotropicTemperatureProperties(self) -> list[IsotropicTemperature]:
3652		return [IsotropicTemperature(isotropicTemperature) for isotropicTemperature in self._Entity.IsotropicTemperatureProperties]
3653
3654	@MaterialFamilyName.setter
3655	def MaterialFamilyName(self, value: str) -> None:
3656		self._Entity.MaterialFamilyName = value
3657
3658	@Name.setter
3659	def Name(self, value: str) -> None:
3660		self._Entity.Name = value
3661
3662	@Form.setter
3663	def Form(self, value: str) -> None:
3664		self._Entity.Form = value
3665
3666	@Specification.setter
3667	def Specification(self, value: str) -> None:
3668		self._Entity.Specification = value
3669
3670	@Temper.setter
3671	def Temper(self, value: str) -> None:
3672		self._Entity.Temper = value
3673
3674	@Basis.setter
3675	def Basis(self, value: str) -> None:
3676		self._Entity.Basis = value
3677
3678	@Density.setter
3679	def Density(self, value: float) -> None:
3680		self._Entity.Density = value
3681
3682	@MaterialDescription.setter
3683	def MaterialDescription(self, value: str) -> None:
3684		self._Entity.MaterialDescription = value
3685
3686	@UserNote.setter
3687	def UserNote(self, value: str) -> None:
3688		self._Entity.UserNote = value
3689
3690	@FemMaterialId.setter
3691	def FemMaterialId(self, value: int) -> None:
3692		self._Entity.FemMaterialId = value
3693
3694	@Cost.setter
3695	def Cost(self, value: float) -> None:
3696		self._Entity.Cost = value
3697
3698	@BucklingStiffnessKnockdown.setter
3699	def BucklingStiffnessKnockdown(self, value: float) -> None:
3700		self._Entity.BucklingStiffnessKnockdown = value
3701
3702	def AddTemperatureProperty(self, temperature: float, et: float, ec: float, g: float, ftuL: float, ftyL: float, fcyL: float, ftuLT: float, ftyLT: float, fcyLT: float, fsu: float, alpha: float, n: float = None, f02: float = None, k: float = None, c: float = None, fbru15: float = None, fbry15: float = None, fbru20: float = None, fbry20: float = None, etyL: float = None, ecyL: float = None, etyLT: float = None, ecyLT: float = None, esu: float = None, fpadh: float = None, fsadh: float = None, esadh: float = None, cd: float = None, ffwt: float = None, ffxz: float = None, ffyz: float = None, ftFatigue: float = None, fcFatigue: float = None) -> IsotropicTemperature:
3703		return IsotropicTemperature(self._Entity.AddTemperatureProperty(temperature, et, ec, g, ftuL, ftyL, fcyL, ftuLT, ftyLT, fcyLT, fsu, alpha, n, f02, k, c, fbru15, fbry15, fbru20, fbry20, etyL, ecyL, etyLT, ecyLT, esu, fpadh, fsadh, esadh, cd, ffwt, ffxz, ffyz, ftFatigue, fcFatigue))
3704
3705	def DeleteTemperatureProperty(self, temperature: float) -> bool:
3706		return self._Entity.DeleteTemperatureProperty(temperature)
3707
3708	def GetTemperature(self, lookupTemperature: float) -> IsotropicTemperature:
3709		return IsotropicTemperature(self._Entity.GetTemperature(lookupTemperature))
3710
3711	def Save(self) -> None:
3712		'''
3713		Save any changes to this isotropic material to the database.
3714		'''
3715		return self._Entity.Save()

Isotropic material.

Isotropic(isotropic: HyperX.Scripting.Isotropic)
3587	def __init__(self, isotropic: _api.Isotropic):
3588		self._Entity = isotropic
MaterialFamilyName: str
3590	@property
3591	def MaterialFamilyName(self) -> str:
3592		return self._Entity.MaterialFamilyName
Id: int
3594	@property
3595	def Id(self) -> int:
3596		return self._Entity.Id
CreationDate: System.DateTime
3598	@property
3599	def CreationDate(self) -> DateTime:
3600		return self._Entity.CreationDate
ModificationDate: System.DateTime
3602	@property
3603	def ModificationDate(self) -> DateTime:
3604		return self._Entity.ModificationDate
Name: str
3606	@property
3607	def Name(self) -> str:
3608		return self._Entity.Name
Form: str
3610	@property
3611	def Form(self) -> str:
3612		return self._Entity.Form
Specification: str
3614	@property
3615	def Specification(self) -> str:
3616		return self._Entity.Specification
Temper: str
3618	@property
3619	def Temper(self) -> str:
3620		return self._Entity.Temper
Basis: str
3622	@property
3623	def Basis(self) -> str:
3624		return self._Entity.Basis
Density: float
3626	@property
3627	def Density(self) -> float:
3628		return self._Entity.Density
MaterialDescription: str
3630	@property
3631	def MaterialDescription(self) -> str:
3632		return self._Entity.MaterialDescription
UserNote: str
3634	@property
3635	def UserNote(self) -> str:
3636		return self._Entity.UserNote
FemMaterialId: int
3638	@property
3639	def FemMaterialId(self) -> int:
3640		return self._Entity.FemMaterialId
Cost: float
3642	@property
3643	def Cost(self) -> float:
3644		return self._Entity.Cost
BucklingStiffnessKnockdown: float
3646	@property
3647	def BucklingStiffnessKnockdown(self) -> float:
3648		return self._Entity.BucklingStiffnessKnockdown
IsotropicTemperatureProperties: list[IsotropicTemperature]
3650	@property
3651	def IsotropicTemperatureProperties(self) -> list[IsotropicTemperature]:
3652		return [IsotropicTemperature(isotropicTemperature) for isotropicTemperature in self._Entity.IsotropicTemperatureProperties]
def AddTemperatureProperty( self, temperature: float, et: float, ec: float, g: float, ftuL: float, ftyL: float, fcyL: float, ftuLT: float, ftyLT: float, fcyLT: float, fsu: float, alpha: float, n: float = None, f02: float = None, k: float = None, c: float = None, fbru15: float = None, fbry15: float = None, fbru20: float = None, fbry20: float = None, etyL: float = None, ecyL: float = None, etyLT: float = None, ecyLT: float = None, esu: float = None, fpadh: float = None, fsadh: float = None, esadh: float = None, cd: float = None, ffwt: float = None, ffxz: float = None, ffyz: float = None, ftFatigue: float = None, fcFatigue: float = None) -> IsotropicTemperature:
3702	def AddTemperatureProperty(self, temperature: float, et: float, ec: float, g: float, ftuL: float, ftyL: float, fcyL: float, ftuLT: float, ftyLT: float, fcyLT: float, fsu: float, alpha: float, n: float = None, f02: float = None, k: float = None, c: float = None, fbru15: float = None, fbry15: float = None, fbru20: float = None, fbry20: float = None, etyL: float = None, ecyL: float = None, etyLT: float = None, ecyLT: float = None, esu: float = None, fpadh: float = None, fsadh: float = None, esadh: float = None, cd: float = None, ffwt: float = None, ffxz: float = None, ffyz: float = None, ftFatigue: float = None, fcFatigue: float = None) -> IsotropicTemperature:
3703		return IsotropicTemperature(self._Entity.AddTemperatureProperty(temperature, et, ec, g, ftuL, ftyL, fcyL, ftuLT, ftyLT, fcyLT, fsu, alpha, n, f02, k, c, fbru15, fbry15, fbru20, fbry20, etyL, ecyL, etyLT, ecyLT, esu, fpadh, fsadh, esadh, cd, ffwt, ffxz, ffyz, ftFatigue, fcFatigue))
def DeleteTemperatureProperty(self, temperature: float) -> bool:
3705	def DeleteTemperatureProperty(self, temperature: float) -> bool:
3706		return self._Entity.DeleteTemperatureProperty(temperature)
def GetTemperature(self, lookupTemperature: float) -> IsotropicTemperature:
3708	def GetTemperature(self, lookupTemperature: float) -> IsotropicTemperature:
3709		return IsotropicTemperature(self._Entity.GetTemperature(lookupTemperature))
def Save(self) -> None:
3711	def Save(self) -> None:
3712		'''
3713		Save any changes to this isotropic material to the database.
3714		'''
3715		return self._Entity.Save()

Save any changes to this isotropic material to the database.

class LaminateBase(abc.ABC):
3718class LaminateBase(ABC):
3719	def __init__(self, laminateBase: _api.LaminateBase):
3720		self._Entity = laminateBase
3721
3722	@property
3723	def Id(self) -> int:
3724		return self._Entity.Id
3725
3726	@property
3727	def Name(self) -> str:
3728		return self._Entity.Name
3729
3730	@property
3731	def IsEditable(self) -> bool:
3732		return self._Entity.IsEditable
3733
3734	@property
3735	def MaterialFamilyName(self) -> str:
3736		return self._Entity.MaterialFamilyName
3737
3738	@property
3739	def LayerCount(self) -> int:
3740		return self._Entity.LayerCount
3741
3742	@property
3743	def Density(self) -> float:
3744		return self._Entity.Density
3745
3746	@property
3747	def Thickness(self) -> float:
3748		return self._Entity.Thickness
3749
3750	@property
3751	def LaminateFamilyId(self) -> int:
3752		return self._Entity.LaminateFamilyId
3753
3754	@property
3755	def LaminateFamilyOrder(self) -> int:
3756		return self._Entity.LaminateFamilyOrder
3757
3758	@property
3759	def HyperLaminate(self) -> bool:
3760		return self._Entity.HyperLaminate
3761
3762	@Name.setter
3763	def Name(self, value: str) -> None:
3764		self._Entity.Name = value
3765
3766	@MaterialFamilyName.setter
3767	def MaterialFamilyName(self, value: str) -> None:
3768		self._Entity.MaterialFamilyName = value
3769
3770	@abstractmethod
3771	def Save(self) -> None:
3772		'''
3773		Save the laminate.
3774		'''
3775		return self._Entity.Save()
Id: int
3722	@property
3723	def Id(self) -> int:
3724		return self._Entity.Id
Name: str
3726	@property
3727	def Name(self) -> str:
3728		return self._Entity.Name
IsEditable: bool
3730	@property
3731	def IsEditable(self) -> bool:
3732		return self._Entity.IsEditable
MaterialFamilyName: str
3734	@property
3735	def MaterialFamilyName(self) -> str:
3736		return self._Entity.MaterialFamilyName
LayerCount: int
3738	@property
3739	def LayerCount(self) -> int:
3740		return self._Entity.LayerCount
Density: float
3742	@property
3743	def Density(self) -> float:
3744		return self._Entity.Density
Thickness: float
3746	@property
3747	def Thickness(self) -> float:
3748		return self._Entity.Thickness
LaminateFamilyId: int
3750	@property
3751	def LaminateFamilyId(self) -> int:
3752		return self._Entity.LaminateFamilyId
LaminateFamilyOrder: int
3754	@property
3755	def LaminateFamilyOrder(self) -> int:
3756		return self._Entity.LaminateFamilyOrder
HyperLaminate: bool
3758	@property
3759	def HyperLaminate(self) -> bool:
3760		return self._Entity.HyperLaminate
@abstractmethod
def Save(self) -> None:
3770	@abstractmethod
3771	def Save(self) -> None:
3772		'''
3773		Save the laminate.
3774		'''
3775		return self._Entity.Save()

Save the laminate.

class LaminateFamily(IdNameEntity):
3778class LaminateFamily(IdNameEntity):
3779	def __init__(self, laminateFamily: _api.LaminateFamily):
3780		self._Entity = laminateFamily
3781
3782	@property
3783	def Laminates(self) -> list[LaminateBase]:
3784		return [LaminateBase(laminateBase) for laminateBase in self._Entity.Laminates]
3785
3786	@property
3787	def ModificationDate(self) -> DateTime:
3788		return self._Entity.ModificationDate
3789
3790	@property
3791	def PlankSetting(self) -> types.LaminateFamilySettingType:
3792		return types.LaminateFamilySettingType[self._Entity.PlankSetting.ToString()]
3793
3794	@property
3795	def PlankMinRatio(self) -> float:
3796		return self._Entity.PlankMinRatio
3797
3798	@property
3799	def PlankMaxRatio(self) -> float:
3800		return self._Entity.PlankMaxRatio
3801
3802	@property
3803	def FootChargeSetting(self) -> types.LaminateFamilySettingType:
3804		return types.LaminateFamilySettingType[self._Entity.FootChargeSetting.ToString()]
3805
3806	@property
3807	def FootChargeMinRatio(self) -> float:
3808		return self._Entity.FootChargeMinRatio
3809
3810	@property
3811	def FootChargeMaxRatio(self) -> float:
3812		return self._Entity.FootChargeMaxRatio
3813
3814	@property
3815	def WebChargeSetting(self) -> types.LaminateFamilySettingType:
3816		return types.LaminateFamilySettingType[self._Entity.WebChargeSetting.ToString()]
3817
3818	@property
3819	def WebChargeMinRatio(self) -> float:
3820		return self._Entity.WebChargeMinRatio
3821
3822	@property
3823	def WebChargeMaxRatio(self) -> float:
3824		return self._Entity.WebChargeMaxRatio
3825
3826	@property
3827	def CapChargeSetting(self) -> types.LaminateFamilySettingType:
3828		return types.LaminateFamilySettingType[self._Entity.CapChargeSetting.ToString()]
3829
3830	@property
3831	def CapChargeMinRatio(self) -> float:
3832		return self._Entity.CapChargeMinRatio
3833
3834	@property
3835	def CapChargeMaxRatio(self) -> float:
3836		return self._Entity.CapChargeMaxRatio
3837
3838	@property
3839	def CapCoverSetting(self) -> types.LaminateFamilySettingType:
3840		return types.LaminateFamilySettingType[self._Entity.CapCoverSetting.ToString()]
3841
3842	@property
3843	def CapCoverMinRatio(self) -> float:
3844		return self._Entity.CapCoverMinRatio
3845
3846	@property
3847	def CapCoverMaxRatio(self) -> float:
3848		return self._Entity.CapCoverMaxRatio
3849
3850	@property
3851	def DropPattern(self) -> types.PlyDropPattern:
3852		return types.PlyDropPattern[self._Entity.DropPattern.ToString()]
3853
3854	@property
3855	def LaminateStiffenerProfile(self) -> types.StiffenerProfile:
3856		return types.StiffenerProfile[self._Entity.LaminateStiffenerProfile.ToString()]

Represents an entity with an ID and Name.

LaminateFamily(laminateFamily: HyperX.Scripting.LaminateFamily)
3779	def __init__(self, laminateFamily: _api.LaminateFamily):
3780		self._Entity = laminateFamily
Laminates: list[LaminateBase]
3782	@property
3783	def Laminates(self) -> list[LaminateBase]:
3784		return [LaminateBase(laminateBase) for laminateBase in self._Entity.Laminates]
ModificationDate: System.DateTime
3786	@property
3787	def ModificationDate(self) -> DateTime:
3788		return self._Entity.ModificationDate
PlankSetting: hyperx.api.types.LaminateFamilySettingType
3790	@property
3791	def PlankSetting(self) -> types.LaminateFamilySettingType:
3792		return types.LaminateFamilySettingType[self._Entity.PlankSetting.ToString()]
PlankMinRatio: float
3794	@property
3795	def PlankMinRatio(self) -> float:
3796		return self._Entity.PlankMinRatio
PlankMaxRatio: float
3798	@property
3799	def PlankMaxRatio(self) -> float:
3800		return self._Entity.PlankMaxRatio
FootChargeSetting: hyperx.api.types.LaminateFamilySettingType
3802	@property
3803	def FootChargeSetting(self) -> types.LaminateFamilySettingType:
3804		return types.LaminateFamilySettingType[self._Entity.FootChargeSetting.ToString()]
FootChargeMinRatio: float
3806	@property
3807	def FootChargeMinRatio(self) -> float:
3808		return self._Entity.FootChargeMinRatio
FootChargeMaxRatio: float
3810	@property
3811	def FootChargeMaxRatio(self) -> float:
3812		return self._Entity.FootChargeMaxRatio
WebChargeSetting: hyperx.api.types.LaminateFamilySettingType
3814	@property
3815	def WebChargeSetting(self) -> types.LaminateFamilySettingType:
3816		return types.LaminateFamilySettingType[self._Entity.WebChargeSetting.ToString()]
WebChargeMinRatio: float
3818	@property
3819	def WebChargeMinRatio(self) -> float:
3820		return self._Entity.WebChargeMinRatio
WebChargeMaxRatio: float
3822	@property
3823	def WebChargeMaxRatio(self) -> float:
3824		return self._Entity.WebChargeMaxRatio
CapChargeSetting: hyperx.api.types.LaminateFamilySettingType
3826	@property
3827	def CapChargeSetting(self) -> types.LaminateFamilySettingType:
3828		return types.LaminateFamilySettingType[self._Entity.CapChargeSetting.ToString()]
CapChargeMinRatio: float
3830	@property
3831	def CapChargeMinRatio(self) -> float:
3832		return self._Entity.CapChargeMinRatio
CapChargeMaxRatio: float
3834	@property
3835	def CapChargeMaxRatio(self) -> float:
3836		return self._Entity.CapChargeMaxRatio
CapCoverSetting: hyperx.api.types.LaminateFamilySettingType
3838	@property
3839	def CapCoverSetting(self) -> types.LaminateFamilySettingType:
3840		return types.LaminateFamilySettingType[self._Entity.CapCoverSetting.ToString()]
CapCoverMinRatio: float
3842	@property
3843	def CapCoverMinRatio(self) -> float:
3844		return self._Entity.CapCoverMinRatio
CapCoverMaxRatio: float
3846	@property
3847	def CapCoverMaxRatio(self) -> float:
3848		return self._Entity.CapCoverMaxRatio
DropPattern: hyperx.api.types.PlyDropPattern
3850	@property
3851	def DropPattern(self) -> types.PlyDropPattern:
3852		return types.PlyDropPattern[self._Entity.DropPattern.ToString()]
LaminateStiffenerProfile: hyperx.api.types.StiffenerProfile
3854	@property
3855	def LaminateStiffenerProfile(self) -> types.StiffenerProfile:
3856		return types.StiffenerProfile[self._Entity.LaminateStiffenerProfile.ToString()]
Inherited Members
IdNameEntity
Name
IdEntity
Id
class LaminateLayerBase(abc.ABC):
3859class LaminateLayerBase(ABC):
3860	def __init__(self, laminateLayerBase: _api.LaminateLayerBase):
3861		self._Entity = laminateLayerBase
3862
3863	@property
3864	def LayerId(self) -> int:
3865		return self._Entity.LayerId
3866
3867	@property
3868	def LayerMaterial(self) -> str:
3869		return self._Entity.LayerMaterial
3870
3871	@property
3872	def LayerMaterialType(self) -> types.MaterialType:
3873		'''
3874		Represents a material's type.
3875		'''
3876		return types.MaterialType[self._Entity.LayerMaterialType.ToString()]
3877
3878	@property
3879	def Angle(self) -> float:
3880		return self._Entity.Angle
3881
3882	@property
3883	def Thickness(self) -> float:
3884		return self._Entity.Thickness
3885
3886	@property
3887	def IsFabric(self) -> bool:
3888		return self._Entity.IsFabric
3889
3890	@Angle.setter
3891	@abstractmethod
3892	def Angle(self, value: float) -> None:
3893		self._Entity.Angle = value
3894
3895	def SetThickness(self, thickness: float) -> None:
3896		return self._Entity.SetThickness(thickness)
3897
3898	@overload
3899	def SetMaterial(self, matId: int) -> bool: ...
3900
3901	@overload
3902	def SetMaterial(self, matName: str) -> bool: ...
3903
3904	def SetMaterial(self, item1 = None) -> bool:
3905		if isinstance(item1, int):
3906			return self._Entity.SetMaterial(item1)
3907
3908		if isinstance(item1, str):
3909			return self._Entity.SetMaterial(item1)
3910
3911		return self._Entity.SetMaterial(item1)
LayerId: int
3863	@property
3864	def LayerId(self) -> int:
3865		return self._Entity.LayerId
LayerMaterial: str
3867	@property
3868	def LayerMaterial(self) -> str:
3869		return self._Entity.LayerMaterial
LayerMaterialType: hyperx.api.types.MaterialType
3871	@property
3872	def LayerMaterialType(self) -> types.MaterialType:
3873		'''
3874		Represents a material's type.
3875		'''
3876		return types.MaterialType[self._Entity.LayerMaterialType.ToString()]

Represents a material's type.

Angle: float
3878	@property
3879	def Angle(self) -> float:
3880		return self._Entity.Angle
Thickness: float
3882	@property
3883	def Thickness(self) -> float:
3884		return self._Entity.Thickness
IsFabric: bool
3886	@property
3887	def IsFabric(self) -> bool:
3888		return self._Entity.IsFabric
def SetThickness(self, thickness: float) -> None:
3895	def SetThickness(self, thickness: float) -> None:
3896		return self._Entity.SetThickness(thickness)
def SetMaterial(self, item1=None) -> bool:
3904	def SetMaterial(self, item1 = None) -> bool:
3905		if isinstance(item1, int):
3906			return self._Entity.SetMaterial(item1)
3907
3908		if isinstance(item1, str):
3909			return self._Entity.SetMaterial(item1)
3910
3911		return self._Entity.SetMaterial(item1)
class LaminateLayer(LaminateLayerBase):
3914class LaminateLayer(LaminateLayerBase):
3915	'''
3916	Layer in a non-stiffener laminate.
3917	'''
3918	def __init__(self, laminateLayer: _api.LaminateLayer):
3919		self._Entity = laminateLayer
3920
3921	@property
3922	def LayerId(self) -> int:
3923		return self._Entity.LayerId
3924
3925	@property
3926	def LayerMaterialType(self) -> types.MaterialType:
3927		'''
3928		Represents a material's type.
3929		'''
3930		return types.MaterialType[self._Entity.LayerMaterialType.ToString()]
3931
3932	@property
3933	def Angle(self) -> float:
3934		return self._Entity.Angle
3935
3936	@property
3937	def Thickness(self) -> float:
3938		return self._Entity.Thickness
3939
3940	@property
3941	def IsFabric(self) -> bool:
3942		return self._Entity.IsFabric
3943
3944	@Angle.setter
3945	def Angle(self, value: float) -> None:
3946		self._Entity.Angle = value
3947
3948	@overload
3949	def SetMaterial(self, matId: int) -> bool: ...
3950
3951	@overload
3952	def SetMaterial(self, matName: str) -> bool: ...
3953
3954	def SetMaterial(self, item1 = None) -> bool:
3955		if isinstance(item1, int):
3956			return bool(super().SetMaterial(item1))
3957
3958		if isinstance(item1, str):
3959			return bool(super().SetMaterial(item1))
3960
3961		return self._Entity.SetMaterial(item1)

Layer in a non-stiffener laminate.

LaminateLayer(laminateLayer: HyperX.Scripting.LaminateLayer)
3918	def __init__(self, laminateLayer: _api.LaminateLayer):
3919		self._Entity = laminateLayer
LayerId: int
3921	@property
3922	def LayerId(self) -> int:
3923		return self._Entity.LayerId
LayerMaterialType: hyperx.api.types.MaterialType
3925	@property
3926	def LayerMaterialType(self) -> types.MaterialType:
3927		'''
3928		Represents a material's type.
3929		'''
3930		return types.MaterialType[self._Entity.LayerMaterialType.ToString()]

Represents a material's type.

Angle: float
3932	@property
3933	def Angle(self) -> float:
3934		return self._Entity.Angle
Thickness: float
3936	@property
3937	def Thickness(self) -> float:
3938		return self._Entity.Thickness
IsFabric: bool
3940	@property
3941	def IsFabric(self) -> bool:
3942		return self._Entity.IsFabric
def SetMaterial(self, item1=None) -> bool:
3954	def SetMaterial(self, item1 = None) -> bool:
3955		if isinstance(item1, int):
3956			return bool(super().SetMaterial(item1))
3957
3958		if isinstance(item1, str):
3959			return bool(super().SetMaterial(item1))
3960
3961		return self._Entity.SetMaterial(item1)
class Laminate(LaminateBase):
3964class Laminate(LaminateBase):
3965	'''
3966	Laminate
3967	'''
3968	def __init__(self, laminate: _api.Laminate):
3969		self._Entity = laminate
3970
3971	@property
3972	def Layers(self) -> list[LaminateLayer]:
3973		return [LaminateLayer(laminateLayer) for laminateLayer in self._Entity.Layers]
3974
3975	def AddLayer(self, materialName: str, angle: float, thickness: float = None) -> LaminateLayer:
3976		return LaminateLayer(self._Entity.AddLayer(materialName, angle, thickness))
3977
3978	def InsertLayer(self, layerId: int, materialName: str, angle: float, thickness: float = None) -> LaminateLayer:
3979		return LaminateLayer(self._Entity.InsertLayer(layerId, materialName, angle, thickness))
3980
3981	def RemoveLayer(self, layerId: int) -> bool:
3982		return self._Entity.RemoveLayer(layerId)
3983
3984	def Save(self) -> None:
3985		'''
3986		Save any changes to this laminate material to the database.
3987		'''
3988		return self._Entity.Save()

Laminate

Laminate(laminate: HyperX.Scripting.Laminate)
3968	def __init__(self, laminate: _api.Laminate):
3969		self._Entity = laminate
Layers: list[LaminateLayer]
3971	@property
3972	def Layers(self) -> list[LaminateLayer]:
3973		return [LaminateLayer(laminateLayer) for laminateLayer in self._Entity.Layers]
def AddLayer( self, materialName: str, angle: float, thickness: float = None) -> LaminateLayer:
3975	def AddLayer(self, materialName: str, angle: float, thickness: float = None) -> LaminateLayer:
3976		return LaminateLayer(self._Entity.AddLayer(materialName, angle, thickness))
def InsertLayer( self, layerId: int, materialName: str, angle: float, thickness: float = None) -> LaminateLayer:
3978	def InsertLayer(self, layerId: int, materialName: str, angle: float, thickness: float = None) -> LaminateLayer:
3979		return LaminateLayer(self._Entity.InsertLayer(layerId, materialName, angle, thickness))
def RemoveLayer(self, layerId: int) -> bool:
3981	def RemoveLayer(self, layerId: int) -> bool:
3982		return self._Entity.RemoveLayer(layerId)
def Save(self) -> None:
3984	def Save(self) -> None:
3985		'''
3986		Save any changes to this laminate material to the database.
3987		'''
3988		return self._Entity.Save()

Save any changes to this laminate material to the database.

class StiffenerLaminateLayer(LaminateLayerBase):
3991class StiffenerLaminateLayer(LaminateLayerBase):
3992	'''
3993	Stiffener Laminate Layer
3994	'''
3995	def __init__(self, stiffenerLaminateLayer: _api.StiffenerLaminateLayer):
3996		self._Entity = stiffenerLaminateLayer
3997
3998	@property
3999	def LayerLocations(self) -> list[types.StiffenerLaminateLayerLocation]:
4000		return [types.StiffenerLaminateLayerLocation[stiffenerLaminateLayerLocation.ToString()] for stiffenerLaminateLayerLocation in self._Entity.LayerLocations]
4001
4002	@property
4003	def LayerId(self) -> int:
4004		return self._Entity.LayerId
4005
4006	@property
4007	def LayerMaterialType(self) -> types.MaterialType:
4008		'''
4009		Represents a material's type.
4010		'''
4011		return types.MaterialType[self._Entity.LayerMaterialType.ToString()]
4012
4013	@property
4014	def Angle(self) -> float:
4015		return self._Entity.Angle
4016
4017	@property
4018	def Thickness(self) -> float:
4019		return self._Entity.Thickness
4020
4021	@property
4022	def IsFabric(self) -> bool:
4023		return self._Entity.IsFabric
4024
4025	@Angle.setter
4026	def Angle(self, value: float) -> None:
4027		self._Entity.Angle = value
4028
4029	def AddLayerLocation(self, location: types.StiffenerLaminateLayerLocation) -> None:
4030		return self._Entity.AddLayerLocation(_types.StiffenerLaminateLayerLocation(location.value))
4031
4032	def RemoveLayerLocation(self, location: types.StiffenerLaminateLayerLocation) -> bool:
4033		return self._Entity.RemoveLayerLocation(_types.StiffenerLaminateLayerLocation(location.value))
4034
4035	@overload
4036	def SetMaterial(self, matId: int) -> bool: ...
4037
4038	@overload
4039	def SetMaterial(self, matName: str) -> bool: ...
4040
4041	def SetMaterial(self, item1 = None) -> bool:
4042		if isinstance(item1, int):
4043			return bool(super().SetMaterial(item1))
4044
4045		if isinstance(item1, str):
4046			return bool(super().SetMaterial(item1))
4047
4048		return self._Entity.SetMaterial(item1)

Stiffener Laminate Layer

StiffenerLaminateLayer(stiffenerLaminateLayer: HyperX.Scripting.StiffenerLaminateLayer)
3995	def __init__(self, stiffenerLaminateLayer: _api.StiffenerLaminateLayer):
3996		self._Entity = stiffenerLaminateLayer
LayerLocations: list[hyperx.api.types.StiffenerLaminateLayerLocation]
3998	@property
3999	def LayerLocations(self) -> list[types.StiffenerLaminateLayerLocation]:
4000		return [types.StiffenerLaminateLayerLocation[stiffenerLaminateLayerLocation.ToString()] for stiffenerLaminateLayerLocation in self._Entity.LayerLocations]
LayerId: int
4002	@property
4003	def LayerId(self) -> int:
4004		return self._Entity.LayerId
LayerMaterialType: hyperx.api.types.MaterialType
4006	@property
4007	def LayerMaterialType(self) -> types.MaterialType:
4008		'''
4009		Represents a material's type.
4010		'''
4011		return types.MaterialType[self._Entity.LayerMaterialType.ToString()]

Represents a material's type.

Angle: float
4013	@property
4014	def Angle(self) -> float:
4015		return self._Entity.Angle
Thickness: float
4017	@property
4018	def Thickness(self) -> float:
4019		return self._Entity.Thickness
IsFabric: bool
4021	@property
4022	def IsFabric(self) -> bool:
4023		return self._Entity.IsFabric
def AddLayerLocation(self, location: hyperx.api.types.StiffenerLaminateLayerLocation) -> None:
4029	def AddLayerLocation(self, location: types.StiffenerLaminateLayerLocation) -> None:
4030		return self._Entity.AddLayerLocation(_types.StiffenerLaminateLayerLocation(location.value))
def RemoveLayerLocation(self, location: hyperx.api.types.StiffenerLaminateLayerLocation) -> bool:
4032	def RemoveLayerLocation(self, location: types.StiffenerLaminateLayerLocation) -> bool:
4033		return self._Entity.RemoveLayerLocation(_types.StiffenerLaminateLayerLocation(location.value))
def SetMaterial(self, item1=None) -> bool:
4041	def SetMaterial(self, item1 = None) -> bool:
4042		if isinstance(item1, int):
4043			return bool(super().SetMaterial(item1))
4044
4045		if isinstance(item1, str):
4046			return bool(super().SetMaterial(item1))
4047
4048		return self._Entity.SetMaterial(item1)
class StiffenerLaminate(LaminateBase):
4051class StiffenerLaminate(LaminateBase):
4052	'''
4053	Stiffener Laminate
4054	'''
4055	def __init__(self, stiffenerLaminate: _api.StiffenerLaminate):
4056		self._Entity = stiffenerLaminate
4057
4058	@property
4059	def Layers(self) -> list[StiffenerLaminateLayer]:
4060		return [StiffenerLaminateLayer(stiffenerLaminateLayer) for stiffenerLaminateLayer in self._Entity.Layers]
4061
4062	@property
4063	def LaminateStiffenerProfile(self) -> types.StiffenerProfile:
4064		return types.StiffenerProfile[self._Entity.LaminateStiffenerProfile.ToString()]
4065
4066	@overload
4067	def AddLayer(self, location: types.StiffenerLaminateLayerLocation, materialName: str, angle: float, thickness: float = None) -> StiffenerLaminateLayer: ...
4068
4069	@overload
4070	def InsertLayer(self, location: types.StiffenerLaminateLayerLocation, layerId: int, materialName: str, angle: float, thickness: float = None) -> StiffenerLaminateLayer: ...
4071
4072	@overload
4073	def AddLayer(self, locations: tuple[types.StiffenerLaminateLayerLocation], materialName: str, angle: float, thickness: float = None) -> StiffenerLaminateLayer: ...
4074
4075	@overload
4076	def InsertLayer(self, locations: tuple[types.StiffenerLaminateLayerLocation], layerId: int, materialName: str, angle: float, thickness: float = None) -> StiffenerLaminateLayer: ...
4077
4078	def RemoveLayer(self, layerId: int) -> bool:
4079		return self._Entity.RemoveLayer(layerId)
4080
4081	def Save(self) -> None:
4082		'''
4083		Save laminate to database.
4084		'''
4085		return self._Entity.Save()
4086
4087	def AddLayer(self, item1 = None, item2 = None, item3 = None, item4 = None) -> StiffenerLaminateLayer:
4088		if isinstance(item1, types.StiffenerLaminateLayerLocation) and isinstance(item2, str) and isinstance(item3, float) and isinstance(item4, float):
4089			return StiffenerLaminateLayer(self._Entity.AddLayer(_types.StiffenerLaminateLayerLocation(item1.value), item2, item3, item4))
4090
4091		if isinstance(item1, tuple) and item1 and isinstance(item1[0], types.StiffenerLaminateLayerLocation) and isinstance(item2, str) and isinstance(item3, float) and isinstance(item4, float):
4092			locationsList = List[_types.StiffenerLaminateLayerLocation]()
4093			if item1 is not None:
4094				for thing in item1:
4095					if thing is not None:
4096						locationsList.Add(_types.StiffenerLaminateLayerLocation(thing.value))
4097			locationsEnumerable = IEnumerable(locationsList)
4098			return StiffenerLaminateLayer(self._Entity.AddLayer(locationsEnumerable, item2, item3, item4))
4099
4100		return StiffenerLaminateLayer(self._Entity.AddLayer(_types.StiffenerLaminateLayerLocation(item1.value), item2, item3, item4))
4101
4102	def InsertLayer(self, item1 = None, item2 = None, item3 = None, item4 = None, item5 = None) -> StiffenerLaminateLayer:
4103		if isinstance(item1, types.StiffenerLaminateLayerLocation) and isinstance(item2, int) and isinstance(item3, str) and isinstance(item4, float) and isinstance(item5, float):
4104			return StiffenerLaminateLayer(self._Entity.InsertLayer(_types.StiffenerLaminateLayerLocation(item1.value), item2, item3, item4, item5))
4105
4106		if isinstance(item1, tuple) and item1 and isinstance(item1[0], types.StiffenerLaminateLayerLocation) and isinstance(item2, int) and isinstance(item3, str) and isinstance(item4, float) and isinstance(item5, float):
4107			locationsList = List[_types.StiffenerLaminateLayerLocation]()
4108			if item1 is not None:
4109				for thing in item1:
4110					if thing is not None:
4111						locationsList.Add(_types.StiffenerLaminateLayerLocation(thing.value))
4112			locationsEnumerable = IEnumerable(locationsList)
4113			return StiffenerLaminateLayer(self._Entity.InsertLayer(locationsEnumerable, item2, item3, item4, item5))
4114
4115		return StiffenerLaminateLayer(self._Entity.InsertLayer(_types.StiffenerLaminateLayerLocation(item1.value), item2, item3, item4, item5))

Stiffener Laminate

StiffenerLaminate(stiffenerLaminate: HyperX.Scripting.StiffenerLaminate)
4055	def __init__(self, stiffenerLaminate: _api.StiffenerLaminate):
4056		self._Entity = stiffenerLaminate
Layers: list[StiffenerLaminateLayer]
4058	@property
4059	def Layers(self) -> list[StiffenerLaminateLayer]:
4060		return [StiffenerLaminateLayer(stiffenerLaminateLayer) for stiffenerLaminateLayer in self._Entity.Layers]
LaminateStiffenerProfile: hyperx.api.types.StiffenerProfile
4062	@property
4063	def LaminateStiffenerProfile(self) -> types.StiffenerProfile:
4064		return types.StiffenerProfile[self._Entity.LaminateStiffenerProfile.ToString()]
def AddLayer( self, item1=None, item2=None, item3=None, item4=None) -> StiffenerLaminateLayer:
4087	def AddLayer(self, item1 = None, item2 = None, item3 = None, item4 = None) -> StiffenerLaminateLayer:
4088		if isinstance(item1, types.StiffenerLaminateLayerLocation) and isinstance(item2, str) and isinstance(item3, float) and isinstance(item4, float):
4089			return StiffenerLaminateLayer(self._Entity.AddLayer(_types.StiffenerLaminateLayerLocation(item1.value), item2, item3, item4))
4090
4091		if isinstance(item1, tuple) and item1 and isinstance(item1[0], types.StiffenerLaminateLayerLocation) and isinstance(item2, str) and isinstance(item3, float) and isinstance(item4, float):
4092			locationsList = List[_types.StiffenerLaminateLayerLocation]()
4093			if item1 is not None:
4094				for thing in item1:
4095					if thing is not None:
4096						locationsList.Add(_types.StiffenerLaminateLayerLocation(thing.value))
4097			locationsEnumerable = IEnumerable(locationsList)
4098			return StiffenerLaminateLayer(self._Entity.AddLayer(locationsEnumerable, item2, item3, item4))
4099
4100		return StiffenerLaminateLayer(self._Entity.AddLayer(_types.StiffenerLaminateLayerLocation(item1.value), item2, item3, item4))
def InsertLayer( self, item1=None, item2=None, item3=None, item4=None, item5=None) -> StiffenerLaminateLayer:
4102	def InsertLayer(self, item1 = None, item2 = None, item3 = None, item4 = None, item5 = None) -> StiffenerLaminateLayer:
4103		if isinstance(item1, types.StiffenerLaminateLayerLocation) and isinstance(item2, int) and isinstance(item3, str) and isinstance(item4, float) and isinstance(item5, float):
4104			return StiffenerLaminateLayer(self._Entity.InsertLayer(_types.StiffenerLaminateLayerLocation(item1.value), item2, item3, item4, item5))
4105
4106		if isinstance(item1, tuple) and item1 and isinstance(item1[0], types.StiffenerLaminateLayerLocation) and isinstance(item2, int) and isinstance(item3, str) and isinstance(item4, float) and isinstance(item5, float):
4107			locationsList = List[_types.StiffenerLaminateLayerLocation]()
4108			if item1 is not None:
4109				for thing in item1:
4110					if thing is not None:
4111						locationsList.Add(_types.StiffenerLaminateLayerLocation(thing.value))
4112			locationsEnumerable = IEnumerable(locationsList)
4113			return StiffenerLaminateLayer(self._Entity.InsertLayer(locationsEnumerable, item2, item3, item4, item5))
4114
4115		return StiffenerLaminateLayer(self._Entity.InsertLayer(_types.StiffenerLaminateLayerLocation(item1.value), item2, item3, item4, item5))
def RemoveLayer(self, layerId: int) -> bool:
4078	def RemoveLayer(self, layerId: int) -> bool:
4079		return self._Entity.RemoveLayer(layerId)
def Save(self) -> None:
4081	def Save(self) -> None:
4082		'''
4083		Save laminate to database.
4084		'''
4085		return self._Entity.Save()

Save laminate to database.

class OrthotropicCorrectionFactorBase(abc.ABC):
4118class OrthotropicCorrectionFactorBase(ABC):
4119	'''
4120	Orthotropic material correction factor.
4121	'''
4122	def __init__(self, orthotropicCorrectionFactorBase: _api.OrthotropicCorrectionFactorBase):
4123		self._Entity = orthotropicCorrectionFactorBase
4124
4125	@property
4126	def CorrectionId(self) -> types.CorrectionId:
4127		'''
4128		Correction ID for a correction factor. (Columns in HyperX)
4129		'''
4130		return types.CorrectionId[self._Entity.CorrectionId.ToString()]
4131
4132	@property
4133	def PropertyId(self) -> types.CorrectionProperty:
4134		'''
4135		Property name for a correction factor. (Rows in HyperX)
4136		'''
4137		return types.CorrectionProperty[self._Entity.PropertyId.ToString()]

Orthotropic material correction factor.

OrthotropicCorrectionFactorBase( orthotropicCorrectionFactorBase: HyperX.Scripting.OrthotropicCorrectionFactorBase)
4122	def __init__(self, orthotropicCorrectionFactorBase: _api.OrthotropicCorrectionFactorBase):
4123		self._Entity = orthotropicCorrectionFactorBase
CorrectionId: hyperx.api.types.CorrectionId
4125	@property
4126	def CorrectionId(self) -> types.CorrectionId:
4127		'''
4128		Correction ID for a correction factor. (Columns in HyperX)
4129		'''
4130		return types.CorrectionId[self._Entity.CorrectionId.ToString()]

Correction ID for a correction factor. (Columns in HyperX)

PropertyId: hyperx.api.types.CorrectionProperty
4132	@property
4133	def PropertyId(self) -> types.CorrectionProperty:
4134		'''
4135		Property name for a correction factor. (Rows in HyperX)
4136		'''
4137		return types.CorrectionProperty[self._Entity.PropertyId.ToString()]

Property name for a correction factor. (Rows in HyperX)

class OrthotropicCorrectionFactorPoint:
4140class OrthotropicCorrectionFactorPoint:
4141	'''
4142	Pointer to an Equation-based or Tabular Correction Factor.
4143	'''
4144	def __init__(self, orthotropicCorrectionFactorPoint: _api.OrthotropicCorrectionFactorPoint):
4145		self._Entity = orthotropicCorrectionFactorPoint
4146
4147	def Create_OrthotropicCorrectionFactorPoint(property: types.CorrectionProperty, id: types.CorrectionId):
4148		return OrthotropicCorrectionFactorPoint(_api.OrthotropicCorrectionFactorPoint(_types.CorrectionProperty(property.value), _types.CorrectionId(id.value)))
4149
4150	@property
4151	def CorrectionProperty(self) -> types.CorrectionProperty:
4152		'''
4153		Property name for a correction factor. (Rows in HyperX)
4154		'''
4155		return types.CorrectionProperty[self._Entity.CorrectionProperty.ToString()]
4156
4157	@property
4158	def CorrectionId(self) -> types.CorrectionId:
4159		'''
4160		Correction ID for a correction factor. (Columns in HyperX)
4161		'''
4162		return types.CorrectionId[self._Entity.CorrectionId.ToString()]
4163
4164	@overload
4165	def Equals(self, other) -> bool: ...
4166
4167	@overload
4168	def Equals(self, obj) -> bool: ...
4169
4170	def GetHashCode(self) -> int:
4171		return self._Entity.GetHashCode()
4172
4173	def Equals(self, item1 = None) -> bool:
4174		if isinstance(item1, OrthotropicCorrectionFactorPoint):
4175			return self._Entity.Equals(item1._Entity)
4176
4177		return self._Entity.Equals(item1._Entity)

Pointer to an Equation-based or Tabular Correction Factor.

OrthotropicCorrectionFactorPoint( orthotropicCorrectionFactorPoint: HyperX.Scripting.OrthotropicCorrectionFactorPoint)
4144	def __init__(self, orthotropicCorrectionFactorPoint: _api.OrthotropicCorrectionFactorPoint):
4145		self._Entity = orthotropicCorrectionFactorPoint
def Create_OrthotropicCorrectionFactorPoint( property: hyperx.api.types.CorrectionProperty, id: hyperx.api.types.CorrectionId):
4147	def Create_OrthotropicCorrectionFactorPoint(property: types.CorrectionProperty, id: types.CorrectionId):
4148		return OrthotropicCorrectionFactorPoint(_api.OrthotropicCorrectionFactorPoint(_types.CorrectionProperty(property.value), _types.CorrectionId(id.value)))
CorrectionProperty: hyperx.api.types.CorrectionProperty
4150	@property
4151	def CorrectionProperty(self) -> types.CorrectionProperty:
4152		'''
4153		Property name for a correction factor. (Rows in HyperX)
4154		'''
4155		return types.CorrectionProperty[self._Entity.CorrectionProperty.ToString()]

Property name for a correction factor. (Rows in HyperX)

CorrectionId: hyperx.api.types.CorrectionId
4157	@property
4158	def CorrectionId(self) -> types.CorrectionId:
4159		'''
4160		Correction ID for a correction factor. (Columns in HyperX)
4161		'''
4162		return types.CorrectionId[self._Entity.CorrectionId.ToString()]

Correction ID for a correction factor. (Columns in HyperX)

def Equals(self, item1=None) -> bool:
4173	def Equals(self, item1 = None) -> bool:
4174		if isinstance(item1, OrthotropicCorrectionFactorPoint):
4175			return self._Entity.Equals(item1._Entity)
4176
4177		return self._Entity.Equals(item1._Entity)
def GetHashCode(self) -> int:
4170	def GetHashCode(self) -> int:
4171		return self._Entity.GetHashCode()
class OrthotropicCorrectionFactorValue:
4180class OrthotropicCorrectionFactorValue:
4181	'''
4182	Orthotropic material equation-based correction factor value. (NOT TABULAR)
4183	'''
4184	def __init__(self, orthotropicCorrectionFactorValue: _api.OrthotropicCorrectionFactorValue):
4185		self._Entity = orthotropicCorrectionFactorValue
4186
4187	@property
4188	def Property(self) -> types.CorrectionProperty:
4189		'''
4190		Property name for a correction factor. (Rows in HyperX)
4191		'''
4192		return types.CorrectionProperty[self._Entity.Property.ToString()]
4193
4194	@property
4195	def Correction(self) -> types.CorrectionId:
4196		'''
4197		Correction ID for a correction factor. (Columns in HyperX)
4198		'''
4199		return types.CorrectionId[self._Entity.Correction.ToString()]
4200
4201	@property
4202	def Equation(self) -> types.CorrectionEquation:
4203		'''
4204		Equation for a correction factor.
4205		'''
4206		return types.CorrectionEquation[self._Entity.Equation.ToString()]
4207
4208	@property
4209	def EquationParameter(self) -> types.EquationParameterId:
4210		'''
4211		Correction factor parameter names.
4212		'''
4213		return types.EquationParameterId[self._Entity.EquationParameter.ToString()]
4214
4215	@property
4216	def Value(self) -> float:
4217		return self._Entity.Value
4218
4219	@Value.setter
4220	def Value(self, value: float) -> None:
4221		self._Entity.Value = value

Orthotropic material equation-based correction factor value. (NOT TABULAR)

OrthotropicCorrectionFactorValue( orthotropicCorrectionFactorValue: HyperX.Scripting.OrthotropicCorrectionFactorValue)
4184	def __init__(self, orthotropicCorrectionFactorValue: _api.OrthotropicCorrectionFactorValue):
4185		self._Entity = orthotropicCorrectionFactorValue
Property: hyperx.api.types.CorrectionProperty
4187	@property
4188	def Property(self) -> types.CorrectionProperty:
4189		'''
4190		Property name for a correction factor. (Rows in HyperX)
4191		'''
4192		return types.CorrectionProperty[self._Entity.Property.ToString()]

Property name for a correction factor. (Rows in HyperX)

Correction: hyperx.api.types.CorrectionId
4194	@property
4195	def Correction(self) -> types.CorrectionId:
4196		'''
4197		Correction ID for a correction factor. (Columns in HyperX)
4198		'''
4199		return types.CorrectionId[self._Entity.Correction.ToString()]

Correction ID for a correction factor. (Columns in HyperX)

Equation: hyperx.api.types.CorrectionEquation
4201	@property
4202	def Equation(self) -> types.CorrectionEquation:
4203		'''
4204		Equation for a correction factor.
4205		'''
4206		return types.CorrectionEquation[self._Entity.Equation.ToString()]

Equation for a correction factor.

EquationParameter: hyperx.api.types.EquationParameterId
4208	@property
4209	def EquationParameter(self) -> types.EquationParameterId:
4210		'''
4211		Correction factor parameter names.
4212		'''
4213		return types.EquationParameterId[self._Entity.EquationParameter.ToString()]

Correction factor parameter names.

Value: float
4215	@property
4216	def Value(self) -> float:
4217		return self._Entity.Value
class OrthotropicEquationCorrectionFactor(OrthotropicCorrectionFactorBase):
4224class OrthotropicEquationCorrectionFactor(OrthotropicCorrectionFactorBase):
4225	'''
4226	Represents an equation-based orthotropic material correction factor.
4227	'''
4228	def __init__(self, orthotropicEquationCorrectionFactor: _api.OrthotropicEquationCorrectionFactor):
4229		self._Entity = orthotropicEquationCorrectionFactor
4230
4231	@property
4232	def Equation(self) -> types.CorrectionEquation:
4233		'''
4234		Equation for a correction factor.
4235		'''
4236		return types.CorrectionEquation[self._Entity.Equation.ToString()]
4237
4238	@property
4239	def OrthotropicCorrectionValues(self) -> dict[types.EquationParameterId, OrthotropicCorrectionFactorValue]:
4240		orthotropicCorrectionValuesDict = {}
4241		for kvp in self._Entity.OrthotropicCorrectionValues:
4242			orthotropicCorrectionValuesDict[types.EquationParameterId[kvp.Key.ToString()]] = OrthotropicCorrectionFactorValue(kvp.Value)
4243
4244		return orthotropicCorrectionValuesDict
4245
4246	def AddCorrectionFactorValue(self, equationParameterName: types.EquationParameterId, valueToAdd: float) -> OrthotropicCorrectionFactorValue:
4247		return OrthotropicCorrectionFactorValue(self._Entity.AddCorrectionFactorValue(_types.EquationParameterId(equationParameterName.value), valueToAdd))

Represents an equation-based orthotropic material correction factor.

OrthotropicEquationCorrectionFactor( orthotropicEquationCorrectionFactor: HyperX.Scripting.OrthotropicEquationCorrectionFactor)
4228	def __init__(self, orthotropicEquationCorrectionFactor: _api.OrthotropicEquationCorrectionFactor):
4229		self._Entity = orthotropicEquationCorrectionFactor
Equation: hyperx.api.types.CorrectionEquation
4231	@property
4232	def Equation(self) -> types.CorrectionEquation:
4233		'''
4234		Equation for a correction factor.
4235		'''
4236		return types.CorrectionEquation[self._Entity.Equation.ToString()]

Equation for a correction factor.

OrthotropicCorrectionValues: dict[hyperx.api.types.EquationParameterId, OrthotropicCorrectionFactorValue]
4238	@property
4239	def OrthotropicCorrectionValues(self) -> dict[types.EquationParameterId, OrthotropicCorrectionFactorValue]:
4240		orthotropicCorrectionValuesDict = {}
4241		for kvp in self._Entity.OrthotropicCorrectionValues:
4242			orthotropicCorrectionValuesDict[types.EquationParameterId[kvp.Key.ToString()]] = OrthotropicCorrectionFactorValue(kvp.Value)
4243
4244		return orthotropicCorrectionValuesDict
def AddCorrectionFactorValue( self, equationParameterName: hyperx.api.types.EquationParameterId, valueToAdd: float) -> OrthotropicCorrectionFactorValue:
4246	def AddCorrectionFactorValue(self, equationParameterName: types.EquationParameterId, valueToAdd: float) -> OrthotropicCorrectionFactorValue:
4247		return OrthotropicCorrectionFactorValue(self._Entity.AddCorrectionFactorValue(_types.EquationParameterId(equationParameterName.value), valueToAdd))
class TabularCorrectionFactorIndependentValue:
4250class TabularCorrectionFactorIndependentValue:
4251	'''
4252	Contains an independent value for a tabular correction factor row.
4253	'''
4254	def __init__(self, tabularCorrectionFactorIndependentValue: _api.TabularCorrectionFactorIndependentValue):
4255		self._Entity = tabularCorrectionFactorIndependentValue
4256
4257	@property
4258	def BoolValue(self) -> bool:
4259		return self._Entity.BoolValue
4260
4261	@property
4262	def DoubleValue(self) -> float:
4263		return self._Entity.DoubleValue
4264
4265	@property
4266	def IntValue(self) -> int:
4267		return self._Entity.IntValue
4268
4269	@property
4270	def ValueType(self) -> types.CorrectionValueType:
4271		'''
4272		Defines the type of the independent values on a tabular correction factor row.
4273		'''
4274		return types.CorrectionValueType[self._Entity.ValueType.ToString()]

Contains an independent value for a tabular correction factor row.

TabularCorrectionFactorIndependentValue( tabularCorrectionFactorIndependentValue: HyperX.Scripting.TabularCorrectionFactorIndependentValue)
4254	def __init__(self, tabularCorrectionFactorIndependentValue: _api.TabularCorrectionFactorIndependentValue):
4255		self._Entity = tabularCorrectionFactorIndependentValue
BoolValue: bool
4257	@property
4258	def BoolValue(self) -> bool:
4259		return self._Entity.BoolValue
DoubleValue: float
4261	@property
4262	def DoubleValue(self) -> float:
4263		return self._Entity.DoubleValue
IntValue: int
4265	@property
4266	def IntValue(self) -> int:
4267		return self._Entity.IntValue
ValueType: hyperx.api.types.CorrectionValueType
4269	@property
4270	def ValueType(self) -> types.CorrectionValueType:
4271		'''
4272		Defines the type of the independent values on a tabular correction factor row.
4273		'''
4274		return types.CorrectionValueType[self._Entity.ValueType.ToString()]

Defines the type of the independent values on a tabular correction factor row.

class TabularCorrectionFactorRow:
4277class TabularCorrectionFactorRow:
4278	'''
4279	Row data for a tabular correction factor.
4280	'''
4281	def __init__(self, tabularCorrectionFactorRow: _api.TabularCorrectionFactorRow):
4282		self._Entity = tabularCorrectionFactorRow
4283
4284	@property
4285	def DependentValue(self) -> float:
4286		return self._Entity.DependentValue
4287
4288	@property
4289	def IndependentValues(self) -> dict[types.CorrectionIndependentDefinition, TabularCorrectionFactorIndependentValue]:
4290		independentValuesDict = {}
4291		for kvp in self._Entity.IndependentValues:
4292			independentValuesDict[types.CorrectionIndependentDefinition[kvp.Key.ToString()]] = TabularCorrectionFactorIndependentValue(kvp.Value)
4293
4294		return independentValuesDict

Row data for a tabular correction factor.

TabularCorrectionFactorRow( tabularCorrectionFactorRow: HyperX.Scripting.TabularCorrectionFactorRow)
4281	def __init__(self, tabularCorrectionFactorRow: _api.TabularCorrectionFactorRow):
4282		self._Entity = tabularCorrectionFactorRow
DependentValue: float
4284	@property
4285	def DependentValue(self) -> float:
4286		return self._Entity.DependentValue
4288	@property
4289	def IndependentValues(self) -> dict[types.CorrectionIndependentDefinition, TabularCorrectionFactorIndependentValue]:
4290		independentValuesDict = {}
4291		for kvp in self._Entity.IndependentValues:
4292			independentValuesDict[types.CorrectionIndependentDefinition[kvp.Key.ToString()]] = TabularCorrectionFactorIndependentValue(kvp.Value)
4293
4294		return independentValuesDict
class OrthotropicTabularCorrectionFactor(OrthotropicCorrectionFactorBase):
4297class OrthotropicTabularCorrectionFactor(OrthotropicCorrectionFactorBase):
4298	'''
4299	Tabular correction factor.
4300	'''
4301	def __init__(self, orthotropicTabularCorrectionFactor: _api.OrthotropicTabularCorrectionFactor):
4302		self._Entity = orthotropicTabularCorrectionFactor
4303
4304	@property
4305	def CorrectionFactorRows(self) -> dict[int, TabularCorrectionFactorRow]:
4306		correctionFactorRowsDict = {}
4307		for kvp in self._Entity.CorrectionFactorRows:
4308			correctionFactorRowsDict[int(kvp.Key)] = TabularCorrectionFactorRow(kvp.Value)
4309
4310		return correctionFactorRowsDict
4311
4312	@property
4313	def CorrectionIndependentDefinitions(self) -> set[types.CorrectionIndependentDefinition]:
4314		return {types.CorrectionIndependentDefinition(correctionIndependentDefinition) for correctionIndependentDefinition in self._Entity.CorrectionIndependentDefinitions}
4315
4316	@overload
4317	def SetIndependentValue(self, correctionPointId: int, cid: types.CorrectionIndependentDefinition, value: float) -> None: ...
4318
4319	@overload
4320	def SetIndependentValue(self, correctionPointId: int, cid: types.CorrectionIndependentDefinition, value: bool) -> None: ...
4321
4322	@overload
4323	def SetIndependentValue(self, correctionPointId: int, cid: types.CorrectionIndependentDefinition, value: int) -> None: ...
4324
4325	def SetKValue(self, correctionPointId: int, value: float) -> None:
4326		return self._Entity.SetKValue(correctionPointId, value)
4327
4328	def SetIndependentValue(self, item1 = None, item2 = None, item3 = None) -> None:
4329		if isinstance(item1, int) and isinstance(item2, types.CorrectionIndependentDefinition) and isinstance(item3, float):
4330			return self._Entity.SetIndependentValue(item1, _types.CorrectionIndependentDefinition(item2.value), item3)
4331
4332		if isinstance(item1, int) and isinstance(item2, types.CorrectionIndependentDefinition) and isinstance(item3, bool):
4333			return self._Entity.SetIndependentValue(item1, _types.CorrectionIndependentDefinition(item2.value), item3)
4334
4335		if isinstance(item1, int) and isinstance(item2, types.CorrectionIndependentDefinition) and isinstance(item3, int):
4336			return self._Entity.SetIndependentValue(item1, _types.CorrectionIndependentDefinition(item2.value), item3)
4337
4338		return self._Entity.SetIndependentValue(item1, _types.CorrectionIndependentDefinition(item2.value), item3)

Tabular correction factor.

OrthotropicTabularCorrectionFactor( orthotropicTabularCorrectionFactor: HyperX.Scripting.OrthotropicTabularCorrectionFactor)
4301	def __init__(self, orthotropicTabularCorrectionFactor: _api.OrthotropicTabularCorrectionFactor):
4302		self._Entity = orthotropicTabularCorrectionFactor
CorrectionFactorRows: dict[int, TabularCorrectionFactorRow]
4304	@property
4305	def CorrectionFactorRows(self) -> dict[int, TabularCorrectionFactorRow]:
4306		correctionFactorRowsDict = {}
4307		for kvp in self._Entity.CorrectionFactorRows:
4308			correctionFactorRowsDict[int(kvp.Key)] = TabularCorrectionFactorRow(kvp.Value)
4309
4310		return correctionFactorRowsDict
CorrectionIndependentDefinitions: set[hyperx.api.types.CorrectionIndependentDefinition]
4312	@property
4313	def CorrectionIndependentDefinitions(self) -> set[types.CorrectionIndependentDefinition]:
4314		return {types.CorrectionIndependentDefinition(correctionIndependentDefinition) for correctionIndependentDefinition in self._Entity.CorrectionIndependentDefinitions}
def SetIndependentValue(self, item1=None, item2=None, item3=None) -> None:
4328	def SetIndependentValue(self, item1 = None, item2 = None, item3 = None) -> None:
4329		if isinstance(item1, int) and isinstance(item2, types.CorrectionIndependentDefinition) and isinstance(item3, float):
4330			return self._Entity.SetIndependentValue(item1, _types.CorrectionIndependentDefinition(item2.value), item3)
4331
4332		if isinstance(item1, int) and isinstance(item2, types.CorrectionIndependentDefinition) and isinstance(item3, bool):
4333			return self._Entity.SetIndependentValue(item1, _types.CorrectionIndependentDefinition(item2.value), item3)
4334
4335		if isinstance(item1, int) and isinstance(item2, types.CorrectionIndependentDefinition) and isinstance(item3, int):
4336			return self._Entity.SetIndependentValue(item1, _types.CorrectionIndependentDefinition(item2.value), item3)
4337
4338		return self._Entity.SetIndependentValue(item1, _types.CorrectionIndependentDefinition(item2.value), item3)
def SetKValue(self, correctionPointId: int, value: float) -> None:
4325	def SetKValue(self, correctionPointId: int, value: float) -> None:
4326		return self._Entity.SetKValue(correctionPointId, value)
class OrthotropicAllowableCurvePoint:
4341class OrthotropicAllowableCurvePoint:
4342	'''
4343	Represents a point on a laminate allowable curve.
4344	'''
4345	def __init__(self, orthotropicAllowableCurvePoint: _api.OrthotropicAllowableCurvePoint):
4346		self._Entity = orthotropicAllowableCurvePoint
4347
4348	@property
4349	def Property_ID(self) -> types.AllowablePropertyName:
4350		'''
4351		Property name for a laminate allowable.
4352		'''
4353		return types.AllowablePropertyName[self._Entity.Property_ID.ToString()]
4354
4355	@property
4356	def Temperature(self) -> float:
4357		return self._Entity.Temperature
4358
4359	@property
4360	def X(self) -> float:
4361		return self._Entity.X
4362
4363	@property
4364	def Y(self) -> float:
4365		return self._Entity.Y
4366
4367	@Property_ID.setter
4368	def Property_ID(self, value: types.AllowablePropertyName) -> None:
4369		self._Entity.Property_ID = _types.AllowablePropertyName(value.value)
4370
4371	@Temperature.setter
4372	def Temperature(self, value: float) -> None:
4373		self._Entity.Temperature = value
4374
4375	@X.setter
4376	def X(self, value: float) -> None:
4377		self._Entity.X = value
4378
4379	@Y.setter
4380	def Y(self, value: float) -> None:
4381		self._Entity.Y = value

Represents a point on a laminate allowable curve.

OrthotropicAllowableCurvePoint( orthotropicAllowableCurvePoint: HyperX.Scripting.OrthotropicAllowableCurvePoint)
4345	def __init__(self, orthotropicAllowableCurvePoint: _api.OrthotropicAllowableCurvePoint):
4346		self._Entity = orthotropicAllowableCurvePoint
Property_ID: hyperx.api.types.AllowablePropertyName
4348	@property
4349	def Property_ID(self) -> types.AllowablePropertyName:
4350		'''
4351		Property name for a laminate allowable.
4352		'''
4353		return types.AllowablePropertyName[self._Entity.Property_ID.ToString()]

Property name for a laminate allowable.

Temperature: float
4355	@property
4356	def Temperature(self) -> float:
4357		return self._Entity.Temperature
X: float
4359	@property
4360	def X(self) -> float:
4361		return self._Entity.X
Y: float
4363	@property
4364	def Y(self) -> float:
4365		return self._Entity.Y
class OrthotropicEffectiveLaminate:
4384class OrthotropicEffectiveLaminate:
4385	'''
4386	Orthotropic material effective laminate properties. Read-only from the API.
4387            Check if material is an effective laminate with orthotropic.IsEffectiveLaminate.
4388	'''
4389	def __init__(self, orthotropicEffectiveLaminate: _api.OrthotropicEffectiveLaminate):
4390		self._Entity = orthotropicEffectiveLaminate
4391
4392	@property
4393	def Percent_tape_0(self) -> float:
4394		return self._Entity.Percent_tape_0
4395
4396	@property
4397	def Percent_tape_90(self) -> float:
4398		return self._Entity.Percent_tape_90
4399
4400	@property
4401	def Percent_tape_45(self) -> float:
4402		return self._Entity.Percent_tape_45
4403
4404	@property
4405	def Percent_fabric_0(self) -> float:
4406		return self._Entity.Percent_fabric_0
4407
4408	@property
4409	def Percent_fabric_90(self) -> float:
4410		return self._Entity.Percent_fabric_90
4411
4412	@property
4413	def Percent_fabric_45(self) -> float:
4414		return self._Entity.Percent_fabric_45
4415
4416	@property
4417	def Tape_Orthotropic(self) -> str:
4418		return self._Entity.Tape_Orthotropic
4419
4420	@property
4421	def Fabric_Orthotropic(self) -> str:
4422		return self._Entity.Fabric_Orthotropic
4423
4424	@property
4425	def Valid(self) -> bool:
4426		return self._Entity.Valid
4427
4428	@property
4429	def Use_tape_allowables(self) -> bool:
4430		return self._Entity.Use_tape_allowables

Orthotropic material effective laminate properties. Read-only from the API. Check if material is an effective laminate with orthotropic.IsEffectiveLaminate.

OrthotropicEffectiveLaminate( orthotropicEffectiveLaminate: HyperX.Scripting.OrthotropicEffectiveLaminate)
4389	def __init__(self, orthotropicEffectiveLaminate: _api.OrthotropicEffectiveLaminate):
4390		self._Entity = orthotropicEffectiveLaminate
Percent_tape_0: float
4392	@property
4393	def Percent_tape_0(self) -> float:
4394		return self._Entity.Percent_tape_0
Percent_tape_90: float
4396	@property
4397	def Percent_tape_90(self) -> float:
4398		return self._Entity.Percent_tape_90
Percent_tape_45: float
4400	@property
4401	def Percent_tape_45(self) -> float:
4402		return self._Entity.Percent_tape_45
Percent_fabric_0: float
4404	@property
4405	def Percent_fabric_0(self) -> float:
4406		return self._Entity.Percent_fabric_0
Percent_fabric_90: float
4408	@property
4409	def Percent_fabric_90(self) -> float:
4410		return self._Entity.Percent_fabric_90
Percent_fabric_45: float
4412	@property
4413	def Percent_fabric_45(self) -> float:
4414		return self._Entity.Percent_fabric_45
Tape_Orthotropic: str
4416	@property
4417	def Tape_Orthotropic(self) -> str:
4418		return self._Entity.Tape_Orthotropic
Fabric_Orthotropic: str
4420	@property
4421	def Fabric_Orthotropic(self) -> str:
4422		return self._Entity.Fabric_Orthotropic
Valid: bool
4424	@property
4425	def Valid(self) -> bool:
4426		return self._Entity.Valid
Use_tape_allowables: bool
4428	@property
4429	def Use_tape_allowables(self) -> bool:
4430		return self._Entity.Use_tape_allowables
class OrthotropicLaminateAllowable:
4433class OrthotropicLaminateAllowable:
4434	'''
4435	Orthotropic material laminate allowable properties.
4436	'''
4437	def __init__(self, orthotropicLaminateAllowable: _api.OrthotropicLaminateAllowable):
4438		self._Entity = orthotropicLaminateAllowable
4439
4440	@property
4441	def Property_ID(self) -> types.AllowablePropertyName:
4442		'''
4443		Property name for a laminate allowable.
4444		'''
4445		return types.AllowablePropertyName[self._Entity.Property_ID.ToString()]
4446
4447	@property
4448	def Method_ID(self) -> types.AllowableMethodName:
4449		'''
4450		Method name for a laminate allowable.
4451		'''
4452		return types.AllowableMethodName[self._Entity.Method_ID.ToString()]
4453
4454	@Property_ID.setter
4455	def Property_ID(self, value: types.AllowablePropertyName) -> None:
4456		self._Entity.Property_ID = _types.AllowablePropertyName(value.value)
4457
4458	@Method_ID.setter
4459	def Method_ID(self, value: types.AllowableMethodName) -> None:
4460		self._Entity.Method_ID = _types.AllowableMethodName(value.value)

Orthotropic material laminate allowable properties.

OrthotropicLaminateAllowable( orthotropicLaminateAllowable: HyperX.Scripting.OrthotropicLaminateAllowable)
4437	def __init__(self, orthotropicLaminateAllowable: _api.OrthotropicLaminateAllowable):
4438		self._Entity = orthotropicLaminateAllowable
Property_ID: hyperx.api.types.AllowablePropertyName
4440	@property
4441	def Property_ID(self) -> types.AllowablePropertyName:
4442		'''
4443		Property name for a laminate allowable.
4444		'''
4445		return types.AllowablePropertyName[self._Entity.Property_ID.ToString()]

Property name for a laminate allowable.

Method_ID: hyperx.api.types.AllowableMethodName
4447	@property
4448	def Method_ID(self) -> types.AllowableMethodName:
4449		'''
4450		Method name for a laminate allowable.
4451		'''
4452		return types.AllowableMethodName[self._Entity.Method_ID.ToString()]

Method name for a laminate allowable.

class OrthotropicTemperature:
4463class OrthotropicTemperature:
4464	'''
4465	Orthotropic material temperature dependent properties.
4466	'''
4467	def __init__(self, orthotropicTemperature: _api.OrthotropicTemperature):
4468		self._Entity = orthotropicTemperature
4469
4470	@property
4471	def Temperature(self) -> float:
4472		return self._Entity.Temperature
4473
4474	@property
4475	def Et1(self) -> float:
4476		return self._Entity.Et1
4477
4478	@property
4479	def Et2(self) -> float:
4480		return self._Entity.Et2
4481
4482	@property
4483	def vt12(self) -> float:
4484		return self._Entity.vt12
4485
4486	@property
4487	def Ec1(self) -> float:
4488		return self._Entity.Ec1
4489
4490	@property
4491	def Ec2(self) -> float:
4492		return self._Entity.Ec2
4493
4494	@property
4495	def vc12(self) -> float:
4496		return self._Entity.vc12
4497
4498	@property
4499	def G12(self) -> float:
4500		return self._Entity.G12
4501
4502	@property
4503	def G13(self) -> float:
4504		return self._Entity.G13
4505
4506	@property
4507	def G23(self) -> float:
4508		return self._Entity.G23
4509
4510	@property
4511	def Ftu1(self) -> float:
4512		return self._Entity.Ftu1
4513
4514	@property
4515	def Ftu2(self) -> float:
4516		return self._Entity.Ftu2
4517
4518	@property
4519	def Fcu1(self) -> float:
4520		return self._Entity.Fcu1
4521
4522	@property
4523	def Fcu2(self) -> float:
4524		return self._Entity.Fcu2
4525
4526	@property
4527	def Fsu12(self) -> float:
4528		return self._Entity.Fsu12
4529
4530	@property
4531	def Fsu13(self) -> float:
4532		return self._Entity.Fsu13
4533
4534	@property
4535	def Fsu23(self) -> float:
4536		return self._Entity.Fsu23
4537
4538	@property
4539	def GIc(self) -> float:
4540		return self._Entity.GIc
4541
4542	@property
4543	def alpha1(self) -> float:
4544		return self._Entity.alpha1
4545
4546	@property
4547	def alpha2(self) -> float:
4548		return self._Entity.alpha2
4549
4550	@property
4551	def K1(self) -> float:
4552		return self._Entity.K1
4553
4554	@property
4555	def K2(self) -> float:
4556		return self._Entity.K2
4557
4558	@property
4559	def C(self) -> float:
4560		return self._Entity.C
4561
4562	@property
4563	def etu1(self) -> float:
4564		return self._Entity.etu1
4565
4566	@property
4567	def etu2(self) -> float:
4568		return self._Entity.etu2
4569
4570	@property
4571	def ecu1(self) -> float:
4572		return self._Entity.ecu1
4573
4574	@property
4575	def ecu2(self) -> float:
4576		return self._Entity.ecu2
4577
4578	@property
4579	def ecuoh(self) -> float:
4580		return self._Entity.ecuoh
4581
4582	@property
4583	def ecuai(self) -> float:
4584		return self._Entity.ecuai
4585
4586	@property
4587	def esu12(self) -> float:
4588		return self._Entity.esu12
4589
4590	@property
4591	def Ftu3(self) -> float:
4592		return self._Entity.Ftu3
4593
4594	@property
4595	def GIIc(self) -> float:
4596		return self._Entity.GIIc
4597
4598	@property
4599	def d0Tension(self) -> float:
4600		return self._Entity.d0Tension
4601
4602	@property
4603	def cd(self) -> float:
4604		return self._Entity.cd
4605
4606	@property
4607	def d0Compression(self) -> float:
4608		return self._Entity.d0Compression
4609
4610	@property
4611	def TLt(self) -> float:
4612		return self._Entity.TLt
4613
4614	@property
4615	def TLc(self) -> float:
4616		return self._Entity.TLc
4617
4618	@property
4619	def TTt(self) -> float:
4620		return self._Entity.TTt
4621
4622	@property
4623	def TTc(self) -> float:
4624		return self._Entity.TTc
4625
4626	@property
4627	def OrthotropicAllowableCurvePoints(self) -> list[OrthotropicAllowableCurvePoint]:
4628		return [OrthotropicAllowableCurvePoint(orthotropicAllowableCurvePoint) for orthotropicAllowableCurvePoint in self._Entity.OrthotropicAllowableCurvePoints]
4629
4630	@Temperature.setter
4631	def Temperature(self, value: float) -> None:
4632		self._Entity.Temperature = value
4633
4634	@Et1.setter
4635	def Et1(self, value: float) -> None:
4636		self._Entity.Et1 = value
4637
4638	@Et2.setter
4639	def Et2(self, value: float) -> None:
4640		self._Entity.Et2 = value
4641
4642	@vt12.setter
4643	def vt12(self, value: float) -> None:
4644		self._Entity.vt12 = value
4645
4646	@Ec1.setter
4647	def Ec1(self, value: float) -> None:
4648		self._Entity.Ec1 = value
4649
4650	@Ec2.setter
4651	def Ec2(self, value: float) -> None:
4652		self._Entity.Ec2 = value
4653
4654	@vc12.setter
4655	def vc12(self, value: float) -> None:
4656		self._Entity.vc12 = value
4657
4658	@G12.setter
4659	def G12(self, value: float) -> None:
4660		self._Entity.G12 = value
4661
4662	@G13.setter
4663	def G13(self, value: float) -> None:
4664		self._Entity.G13 = value
4665
4666	@G23.setter
4667	def G23(self, value: float) -> None:
4668		self._Entity.G23 = value
4669
4670	@Ftu1.setter
4671	def Ftu1(self, value: float) -> None:
4672		self._Entity.Ftu1 = value
4673
4674	@Ftu2.setter
4675	def Ftu2(self, value: float) -> None:
4676		self._Entity.Ftu2 = value
4677
4678	@Fcu1.setter
4679	def Fcu1(self, value: float) -> None:
4680		self._Entity.Fcu1 = value
4681
4682	@Fcu2.setter
4683	def Fcu2(self, value: float) -> None:
4684		self._Entity.Fcu2 = value
4685
4686	@Fsu12.setter
4687	def Fsu12(self, value: float) -> None:
4688		self._Entity.Fsu12 = value
4689
4690	@Fsu13.setter
4691	def Fsu13(self, value: float) -> None:
4692		self._Entity.Fsu13 = value
4693
4694	@Fsu23.setter
4695	def Fsu23(self, value: float) -> None:
4696		self._Entity.Fsu23 = value
4697
4698	@GIc.setter
4699	def GIc(self, value: float) -> None:
4700		self._Entity.GIc = value
4701
4702	@alpha1.setter
4703	def alpha1(self, value: float) -> None:
4704		self._Entity.alpha1 = value
4705
4706	@alpha2.setter
4707	def alpha2(self, value: float) -> None:
4708		self._Entity.alpha2 = value
4709
4710	@K1.setter
4711	def K1(self, value: float) -> None:
4712		self._Entity.K1 = value
4713
4714	@K2.setter
4715	def K2(self, value: float) -> None:
4716		self._Entity.K2 = value
4717
4718	@C.setter
4719	def C(self, value: float) -> None:
4720		self._Entity.C = value
4721
4722	@etu1.setter
4723	def etu1(self, value: float) -> None:
4724		self._Entity.etu1 = value
4725
4726	@etu2.setter
4727	def etu2(self, value: float) -> None:
4728		self._Entity.etu2 = value
4729
4730	@ecu1.setter
4731	def ecu1(self, value: float) -> None:
4732		self._Entity.ecu1 = value
4733
4734	@ecu2.setter
4735	def ecu2(self, value: float) -> None:
4736		self._Entity.ecu2 = value
4737
4738	@ecuoh.setter
4739	def ecuoh(self, value: float) -> None:
4740		self._Entity.ecuoh = value
4741
4742	@ecuai.setter
4743	def ecuai(self, value: float) -> None:
4744		self._Entity.ecuai = value
4745
4746	@esu12.setter
4747	def esu12(self, value: float) -> None:
4748		self._Entity.esu12 = value
4749
4750	@Ftu3.setter
4751	def Ftu3(self, value: float) -> None:
4752		self._Entity.Ftu3 = value
4753
4754	@GIIc.setter
4755	def GIIc(self, value: float) -> None:
4756		self._Entity.GIIc = value
4757
4758	@d0Tension.setter
4759	def d0Tension(self, value: float) -> None:
4760		self._Entity.d0Tension = value
4761
4762	@cd.setter
4763	def cd(self, value: float) -> None:
4764		self._Entity.cd = value
4765
4766	@d0Compression.setter
4767	def d0Compression(self, value: float) -> None:
4768		self._Entity.d0Compression = value
4769
4770	@TLt.setter
4771	def TLt(self, value: float) -> None:
4772		self._Entity.TLt = value
4773
4774	@TLc.setter
4775	def TLc(self, value: float) -> None:
4776		self._Entity.TLc = value
4777
4778	@TTt.setter
4779	def TTt(self, value: float) -> None:
4780		self._Entity.TTt = value
4781
4782	@TTc.setter
4783	def TTc(self, value: float) -> None:
4784		self._Entity.TTc = value
4785
4786	def AddCurvePoint(self, property: types.AllowablePropertyName, x: float, y: float) -> OrthotropicAllowableCurvePoint:
4787		return OrthotropicAllowableCurvePoint(self._Entity.AddCurvePoint(_types.AllowablePropertyName(property.value), x, y))
4788
4789	def DeleteCurvePoint(self, property: types.AllowablePropertyName, x: float) -> bool:
4790		return self._Entity.DeleteCurvePoint(_types.AllowablePropertyName(property.value), x)
4791
4792	def GetCurvePoint(self, property: types.AllowablePropertyName, x: float) -> OrthotropicAllowableCurvePoint:
4793		return OrthotropicAllowableCurvePoint(self._Entity.GetCurvePoint(_types.AllowablePropertyName(property.value), x))

Orthotropic material temperature dependent properties.

OrthotropicTemperature(orthotropicTemperature: HyperX.Scripting.OrthotropicTemperature)
4467	def __init__(self, orthotropicTemperature: _api.OrthotropicTemperature):
4468		self._Entity = orthotropicTemperature
Temperature: float
4470	@property
4471	def Temperature(self) -> float:
4472		return self._Entity.Temperature
Et1: float
4474	@property
4475	def Et1(self) -> float:
4476		return self._Entity.Et1
Et2: float
4478	@property
4479	def Et2(self) -> float:
4480		return self._Entity.Et2
vt12: float
4482	@property
4483	def vt12(self) -> float:
4484		return self._Entity.vt12
Ec1: float
4486	@property
4487	def Ec1(self) -> float:
4488		return self._Entity.Ec1
Ec2: float
4490	@property
4491	def Ec2(self) -> float:
4492		return self._Entity.Ec2
vc12: float
4494	@property
4495	def vc12(self) -> float:
4496		return self._Entity.vc12
G12: float
4498	@property
4499	def G12(self) -> float:
4500		return self._Entity.G12
G13: float
4502	@property
4503	def G13(self) -> float:
4504		return self._Entity.G13
G23: float
4506	@property
4507	def G23(self) -> float:
4508		return self._Entity.G23
Ftu1: float
4510	@property
4511	def Ftu1(self) -> float:
4512		return self._Entity.Ftu1
Ftu2: float
4514	@property
4515	def Ftu2(self) -> float:
4516		return self._Entity.Ftu2
Fcu1: float
4518	@property
4519	def Fcu1(self) -> float:
4520		return self._Entity.Fcu1
Fcu2: float
4522	@property
4523	def Fcu2(self) -> float:
4524		return self._Entity.Fcu2
Fsu12: float
4526	@property
4527	def Fsu12(self) -> float:
4528		return self._Entity.Fsu12
Fsu13: float
4530	@property
4531	def Fsu13(self) -> float:
4532		return self._Entity.Fsu13
Fsu23: float
4534	@property
4535	def Fsu23(self) -> float:
4536		return self._Entity.Fsu23
GIc: float
4538	@property
4539	def GIc(self) -> float:
4540		return self._Entity.GIc
alpha1: float
4542	@property
4543	def alpha1(self) -> float:
4544		return self._Entity.alpha1
alpha2: float
4546	@property
4547	def alpha2(self) -> float:
4548		return self._Entity.alpha2
K1: float
4550	@property
4551	def K1(self) -> float:
4552		return self._Entity.K1
K2: float
4554	@property
4555	def K2(self) -> float:
4556		return self._Entity.K2
C: float
4558	@property
4559	def C(self) -> float:
4560		return self._Entity.C
etu1: float
4562	@property
4563	def etu1(self) -> float:
4564		return self._Entity.etu1
etu2: float
4566	@property
4567	def etu2(self) -> float:
4568		return self._Entity.etu2
ecu1: float
4570	@property
4571	def ecu1(self) -> float:
4572		return self._Entity.ecu1
ecu2: float
4574	@property
4575	def ecu2(self) -> float:
4576		return self._Entity.ecu2
ecuoh: float
4578	@property
4579	def ecuoh(self) -> float:
4580		return self._Entity.ecuoh
ecuai: float
4582	@property
4583	def ecuai(self) -> float:
4584		return self._Entity.ecuai
esu12: float
4586	@property
4587	def esu12(self) -> float:
4588		return self._Entity.esu12
Ftu3: float
4590	@property
4591	def Ftu3(self) -> float:
4592		return self._Entity.Ftu3
GIIc: float
4594	@property
4595	def GIIc(self) -> float:
4596		return self._Entity.GIIc
d0Tension: float
4598	@property
4599	def d0Tension(self) -> float:
4600		return self._Entity.d0Tension
cd: float
4602	@property
4603	def cd(self) -> float:
4604		return self._Entity.cd
d0Compression: float
4606	@property
4607	def d0Compression(self) -> float:
4608		return self._Entity.d0Compression
TLt: float
4610	@property
4611	def TLt(self) -> float:
4612		return self._Entity.TLt
TLc: float
4614	@property
4615	def TLc(self) -> float:
4616		return self._Entity.TLc
TTt: float
4618	@property
4619	def TTt(self) -> float:
4620		return self._Entity.TTt
TTc: float
4622	@property
4623	def TTc(self) -> float:
4624		return self._Entity.TTc
OrthotropicAllowableCurvePoints: list[OrthotropicAllowableCurvePoint]
4626	@property
4627	def OrthotropicAllowableCurvePoints(self) -> list[OrthotropicAllowableCurvePoint]:
4628		return [OrthotropicAllowableCurvePoint(orthotropicAllowableCurvePoint) for orthotropicAllowableCurvePoint in self._Entity.OrthotropicAllowableCurvePoints]
def AddCurvePoint( self, property: hyperx.api.types.AllowablePropertyName, x: float, y: float) -> OrthotropicAllowableCurvePoint:
4786	def AddCurvePoint(self, property: types.AllowablePropertyName, x: float, y: float) -> OrthotropicAllowableCurvePoint:
4787		return OrthotropicAllowableCurvePoint(self._Entity.AddCurvePoint(_types.AllowablePropertyName(property.value), x, y))
def DeleteCurvePoint(self, property: hyperx.api.types.AllowablePropertyName, x: float) -> bool:
4789	def DeleteCurvePoint(self, property: types.AllowablePropertyName, x: float) -> bool:
4790		return self._Entity.DeleteCurvePoint(_types.AllowablePropertyName(property.value), x)
def GetCurvePoint( self, property: hyperx.api.types.AllowablePropertyName, x: float) -> OrthotropicAllowableCurvePoint:
4792	def GetCurvePoint(self, property: types.AllowablePropertyName, x: float) -> OrthotropicAllowableCurvePoint:
4793		return OrthotropicAllowableCurvePoint(self._Entity.GetCurvePoint(_types.AllowablePropertyName(property.value), x))
class Orthotropic:
4796class Orthotropic:
4797	'''
4798	Orthotropic material.
4799	'''
4800	def __init__(self, orthotropic: _api.Orthotropic):
4801		self._Entity = orthotropic
4802
4803	@property
4804	def MaterialFamilyName(self) -> str:
4805		return self._Entity.MaterialFamilyName
4806
4807	@property
4808	def Id(self) -> int:
4809		return self._Entity.Id
4810
4811	@property
4812	def CreationDate(self) -> DateTime:
4813		return self._Entity.CreationDate
4814
4815	@property
4816	def ModificationDate(self) -> DateTime:
4817		return self._Entity.ModificationDate
4818
4819	@property
4820	def Name(self) -> str:
4821		return self._Entity.Name
4822
4823	@property
4824	def Form(self) -> str:
4825		return self._Entity.Form
4826
4827	@property
4828	def Specification(self) -> str:
4829		return self._Entity.Specification
4830
4831	@property
4832	def Basis(self) -> str:
4833		return self._Entity.Basis
4834
4835	@property
4836	def Wet(self) -> bool:
4837		return self._Entity.Wet
4838
4839	@property
4840	def Thickness(self) -> float:
4841		return self._Entity.Thickness
4842
4843	@property
4844	def Density(self) -> float:
4845		return self._Entity.Density
4846
4847	@property
4848	def FiberVolume(self) -> float:
4849		return self._Entity.FiberVolume
4850
4851	@property
4852	def GlassTransition(self) -> float:
4853		return self._Entity.GlassTransition
4854
4855	@property
4856	def Manufacturer(self) -> str:
4857		return self._Entity.Manufacturer
4858
4859	@property
4860	def Processes(self) -> str:
4861		return self._Entity.Processes
4862
4863	@property
4864	def MaterialDescription(self) -> str:
4865		return self._Entity.MaterialDescription
4866
4867	@property
4868	def UserNote(self) -> str:
4869		return self._Entity.UserNote
4870
4871	@property
4872	def BendingCorrectionFactor(self) -> float:
4873		return self._Entity.BendingCorrectionFactor
4874
4875	@property
4876	def FemMaterialId(self) -> int:
4877		return self._Entity.FemMaterialId
4878
4879	@property
4880	def Cost(self) -> float:
4881		return self._Entity.Cost
4882
4883	@property
4884	def BucklingStiffnessKnockdown(self) -> float:
4885		return self._Entity.BucklingStiffnessKnockdown
4886
4887	@property
4888	def OrthotropicTemperatureProperties(self) -> list[OrthotropicTemperature]:
4889		return [OrthotropicTemperature(orthotropicTemperature) for orthotropicTemperature in self._Entity.OrthotropicTemperatureProperties]
4890
4891	@property
4892	def OrthotropicLaminateAllowables(self) -> list[OrthotropicLaminateAllowable]:
4893		return [OrthotropicLaminateAllowable(orthotropicLaminateAllowable) for orthotropicLaminateAllowable in self._Entity.OrthotropicLaminateAllowables]
4894
4895	@property
4896	def OrthotropicEffectiveLaminate(self) -> OrthotropicEffectiveLaminate:
4897		'''
4898		Orthotropic material effective laminate properties. Read-only from the API.
4899            Check if material is an effective laminate with orthotropic.IsEffectiveLaminate.
4900		'''
4901		result = self._Entity.OrthotropicEffectiveLaminate
4902		return OrthotropicEffectiveLaminate(result) if result is not None else None
4903
4904	@property
4905	def OrthotropicEquationCorrectionFactors(self) -> dict[OrthotropicCorrectionFactorPoint, OrthotropicEquationCorrectionFactor]:
4906		orthotropicEquationCorrectionFactorsDict = {}
4907		for kvp in self._Entity.OrthotropicEquationCorrectionFactors:
4908			orthotropicEquationCorrectionFactorsDict[OrthotropicCorrectionFactorPoint(kvp.Key)] = OrthotropicEquationCorrectionFactor(kvp.Value)
4909
4910		return orthotropicEquationCorrectionFactorsDict
4911
4912	@property
4913	def OrthotropicTabularCorrectionFactors(self) -> dict[OrthotropicCorrectionFactorPoint, OrthotropicTabularCorrectionFactor]:
4914		orthotropicTabularCorrectionFactorsDict = {}
4915		for kvp in self._Entity.OrthotropicTabularCorrectionFactors:
4916			orthotropicTabularCorrectionFactorsDict[OrthotropicCorrectionFactorPoint(kvp.Key)] = OrthotropicTabularCorrectionFactor(kvp.Value)
4917
4918		return orthotropicTabularCorrectionFactorsDict
4919
4920	@MaterialFamilyName.setter
4921	def MaterialFamilyName(self, value: str) -> None:
4922		self._Entity.MaterialFamilyName = value
4923
4924	@Name.setter
4925	def Name(self, value: str) -> None:
4926		self._Entity.Name = value
4927
4928	@Form.setter
4929	def Form(self, value: str) -> None:
4930		self._Entity.Form = value
4931
4932	@Specification.setter
4933	def Specification(self, value: str) -> None:
4934		self._Entity.Specification = value
4935
4936	@Basis.setter
4937	def Basis(self, value: str) -> None:
4938		self._Entity.Basis = value
4939
4940	@Wet.setter
4941	def Wet(self, value: bool) -> None:
4942		self._Entity.Wet = value
4943
4944	@Thickness.setter
4945	def Thickness(self, value: float) -> None:
4946		self._Entity.Thickness = value
4947
4948	@Density.setter
4949	def Density(self, value: float) -> None:
4950		self._Entity.Density = value
4951
4952	@FiberVolume.setter
4953	def FiberVolume(self, value: float) -> None:
4954		self._Entity.FiberVolume = value
4955
4956	@GlassTransition.setter
4957	def GlassTransition(self, value: float) -> None:
4958		self._Entity.GlassTransition = value
4959
4960	@Manufacturer.setter
4961	def Manufacturer(self, value: str) -> None:
4962		self._Entity.Manufacturer = value
4963
4964	@Processes.setter
4965	def Processes(self, value: str) -> None:
4966		self._Entity.Processes = value
4967
4968	@MaterialDescription.setter
4969	def MaterialDescription(self, value: str) -> None:
4970		self._Entity.MaterialDescription = value
4971
4972	@UserNote.setter
4973	def UserNote(self, value: str) -> None:
4974		self._Entity.UserNote = value
4975
4976	@BendingCorrectionFactor.setter
4977	def BendingCorrectionFactor(self, value: float) -> None:
4978		self._Entity.BendingCorrectionFactor = value
4979
4980	@FemMaterialId.setter
4981	def FemMaterialId(self, value: int) -> None:
4982		self._Entity.FemMaterialId = value
4983
4984	@Cost.setter
4985	def Cost(self, value: float) -> None:
4986		self._Entity.Cost = value
4987
4988	@BucklingStiffnessKnockdown.setter
4989	def BucklingStiffnessKnockdown(self, value: float) -> None:
4990		self._Entity.BucklingStiffnessKnockdown = value
4991
4992	def AddTemperatureProperty(self, temperature: float, et1: float, et2: float, vt12: float, ec1: float, ec2: float, vc12: float, g12: float, ftu1: float, ftu2: float, fcu1: float, fcu2: float, fsu12: float, alpha1: float, alpha2: float, etu1: float, etu2: float, ecu1: float, ecu2: float, esu12: float) -> OrthotropicTemperature:
4993		return OrthotropicTemperature(self._Entity.AddTemperatureProperty(temperature, et1, et2, vt12, ec1, ec2, vc12, g12, ftu1, ftu2, fcu1, fcu2, fsu12, alpha1, alpha2, etu1, etu2, ecu1, ecu2, esu12))
4994
4995	def DeleteTemperatureProperty(self, temperature: float) -> bool:
4996		return self._Entity.DeleteTemperatureProperty(temperature)
4997
4998	def GetTemperature(self, lookupTemperature: float) -> OrthotropicTemperature:
4999		return OrthotropicTemperature(self._Entity.GetTemperature(lookupTemperature))
5000
5001	def IsEffectiveLaminate(self) -> bool:
5002		'''
5003		Returns true if this material is an effective laminate.
5004		'''
5005		return self._Entity.IsEffectiveLaminate()
5006
5007	def HasLaminateAllowable(self, property: types.AllowablePropertyName) -> bool:
5008		return self._Entity.HasLaminateAllowable(_types.AllowablePropertyName(property.value))
5009
5010	def AddLaminateAllowable(self, property: types.AllowablePropertyName, method: types.AllowableMethodName) -> OrthotropicLaminateAllowable:
5011		return OrthotropicLaminateAllowable(self._Entity.AddLaminateAllowable(_types.AllowablePropertyName(property.value), _types.AllowableMethodName(method.value)))
5012
5013	def GetLaminateAllowable(self, lookupAllowableProperty: types.AllowablePropertyName) -> OrthotropicLaminateAllowable:
5014		return OrthotropicLaminateAllowable(self._Entity.GetLaminateAllowable(_types.AllowablePropertyName(lookupAllowableProperty.value)))
5015
5016	def AddEquationCorrectionFactor(self, propertyId: types.CorrectionProperty, correctionId: types.CorrectionId, equationId: types.CorrectionEquation) -> OrthotropicEquationCorrectionFactor:
5017		return OrthotropicEquationCorrectionFactor(self._Entity.AddEquationCorrectionFactor(_types.CorrectionProperty(propertyId.value), _types.CorrectionId(correctionId.value), _types.CorrectionEquation(equationId.value)))
5018
5019	def GetEquationCorrectionFactor(self, property: types.CorrectionProperty, correction: types.CorrectionId) -> OrthotropicEquationCorrectionFactor:
5020		return OrthotropicEquationCorrectionFactor(self._Entity.GetEquationCorrectionFactor(_types.CorrectionProperty(property.value), _types.CorrectionId(correction.value)))
5021
5022	def GetTabularCorrectionFactor(self, property: types.CorrectionProperty, correction: types.CorrectionId) -> OrthotropicTabularCorrectionFactor:
5023		return OrthotropicTabularCorrectionFactor(self._Entity.GetTabularCorrectionFactor(_types.CorrectionProperty(property.value), _types.CorrectionId(correction.value)))
5024
5025	def Save(self) -> None:
5026		'''
5027		Save any changes to this orthotropic material to the database.
5028		'''
5029		return self._Entity.Save()

Orthotropic material.

Orthotropic(orthotropic: HyperX.Scripting.Orthotropic)
4800	def __init__(self, orthotropic: _api.Orthotropic):
4801		self._Entity = orthotropic
MaterialFamilyName: str
4803	@property
4804	def MaterialFamilyName(self) -> str:
4805		return self._Entity.MaterialFamilyName
Id: int
4807	@property
4808	def Id(self) -> int:
4809		return self._Entity.Id
CreationDate: System.DateTime
4811	@property
4812	def CreationDate(self) -> DateTime:
4813		return self._Entity.CreationDate
ModificationDate: System.DateTime
4815	@property
4816	def ModificationDate(self) -> DateTime:
4817		return self._Entity.ModificationDate
Name: str
4819	@property
4820	def Name(self) -> str:
4821		return self._Entity.Name
Form: str
4823	@property
4824	def Form(self) -> str:
4825		return self._Entity.Form
Specification: str
4827	@property
4828	def Specification(self) -> str:
4829		return self._Entity.Specification
Basis: str
4831	@property
4832	def Basis(self) -> str:
4833		return self._Entity.Basis
Wet: bool
4835	@property
4836	def Wet(self) -> bool:
4837		return self._Entity.Wet
Thickness: float
4839	@property
4840	def Thickness(self) -> float:
4841		return self._Entity.Thickness
Density: float
4843	@property
4844	def Density(self) -> float:
4845		return self._Entity.Density
FiberVolume: float
4847	@property
4848	def FiberVolume(self) -> float:
4849		return self._Entity.FiberVolume
GlassTransition: float
4851	@property
4852	def GlassTransition(self) -> float:
4853		return self._Entity.GlassTransition
Manufacturer: str
4855	@property
4856	def Manufacturer(self) -> str:
4857		return self._Entity.Manufacturer
Processes: str
4859	@property
4860	def Processes(self) -> str:
4861		return self._Entity.Processes
MaterialDescription: str
4863	@property
4864	def MaterialDescription(self) -> str:
4865		return self._Entity.MaterialDescription
UserNote: str
4867	@property
4868	def UserNote(self) -> str:
4869		return self._Entity.UserNote
BendingCorrectionFactor: float
4871	@property
4872	def BendingCorrectionFactor(self) -> float:
4873		return self._Entity.BendingCorrectionFactor
FemMaterialId: int
4875	@property
4876	def FemMaterialId(self) -> int:
4877		return self._Entity.FemMaterialId
Cost: float
4879	@property
4880	def Cost(self) -> float:
4881		return self._Entity.Cost
BucklingStiffnessKnockdown: float
4883	@property
4884	def BucklingStiffnessKnockdown(self) -> float:
4885		return self._Entity.BucklingStiffnessKnockdown
OrthotropicTemperatureProperties: list[OrthotropicTemperature]
4887	@property
4888	def OrthotropicTemperatureProperties(self) -> list[OrthotropicTemperature]:
4889		return [OrthotropicTemperature(orthotropicTemperature) for orthotropicTemperature in self._Entity.OrthotropicTemperatureProperties]
OrthotropicLaminateAllowables: list[OrthotropicLaminateAllowable]
4891	@property
4892	def OrthotropicLaminateAllowables(self) -> list[OrthotropicLaminateAllowable]:
4893		return [OrthotropicLaminateAllowable(orthotropicLaminateAllowable) for orthotropicLaminateAllowable in self._Entity.OrthotropicLaminateAllowables]
OrthotropicEffectiveLaminate: <property object at 0x000001C374AFF330>
4895	@property
4896	def OrthotropicEffectiveLaminate(self) -> OrthotropicEffectiveLaminate:
4897		'''
4898		Orthotropic material effective laminate properties. Read-only from the API.
4899            Check if material is an effective laminate with orthotropic.IsEffectiveLaminate.
4900		'''
4901		result = self._Entity.OrthotropicEffectiveLaminate
4902		return OrthotropicEffectiveLaminate(result) if result is not None else None

Orthotropic material effective laminate properties. Read-only from the API. Check if material is an effective laminate with orthotropic.IsEffectiveLaminate.

OrthotropicEquationCorrectionFactors: dict[OrthotropicCorrectionFactorPoint, OrthotropicEquationCorrectionFactor]
4904	@property
4905	def OrthotropicEquationCorrectionFactors(self) -> dict[OrthotropicCorrectionFactorPoint, OrthotropicEquationCorrectionFactor]:
4906		orthotropicEquationCorrectionFactorsDict = {}
4907		for kvp in self._Entity.OrthotropicEquationCorrectionFactors:
4908			orthotropicEquationCorrectionFactorsDict[OrthotropicCorrectionFactorPoint(kvp.Key)] = OrthotropicEquationCorrectionFactor(kvp.Value)
4909
4910		return orthotropicEquationCorrectionFactorsDict
OrthotropicTabularCorrectionFactors: dict[OrthotropicCorrectionFactorPoint, OrthotropicTabularCorrectionFactor]
4912	@property
4913	def OrthotropicTabularCorrectionFactors(self) -> dict[OrthotropicCorrectionFactorPoint, OrthotropicTabularCorrectionFactor]:
4914		orthotropicTabularCorrectionFactorsDict = {}
4915		for kvp in self._Entity.OrthotropicTabularCorrectionFactors:
4916			orthotropicTabularCorrectionFactorsDict[OrthotropicCorrectionFactorPoint(kvp.Key)] = OrthotropicTabularCorrectionFactor(kvp.Value)
4917
4918		return orthotropicTabularCorrectionFactorsDict
def AddTemperatureProperty( self, temperature: float, et1: float, et2: float, vt12: float, ec1: float, ec2: float, vc12: float, g12: float, ftu1: float, ftu2: float, fcu1: float, fcu2: float, fsu12: float, alpha1: float, alpha2: float, etu1: float, etu2: float, ecu1: float, ecu2: float, esu12: float) -> OrthotropicTemperature:
4992	def AddTemperatureProperty(self, temperature: float, et1: float, et2: float, vt12: float, ec1: float, ec2: float, vc12: float, g12: float, ftu1: float, ftu2: float, fcu1: float, fcu2: float, fsu12: float, alpha1: float, alpha2: float, etu1: float, etu2: float, ecu1: float, ecu2: float, esu12: float) -> OrthotropicTemperature:
4993		return OrthotropicTemperature(self._Entity.AddTemperatureProperty(temperature, et1, et2, vt12, ec1, ec2, vc12, g12, ftu1, ftu2, fcu1, fcu2, fsu12, alpha1, alpha2, etu1, etu2, ecu1, ecu2, esu12))
def DeleteTemperatureProperty(self, temperature: float) -> bool:
4995	def DeleteTemperatureProperty(self, temperature: float) -> bool:
4996		return self._Entity.DeleteTemperatureProperty(temperature)
def GetTemperature(self, lookupTemperature: float) -> OrthotropicTemperature:
4998	def GetTemperature(self, lookupTemperature: float) -> OrthotropicTemperature:
4999		return OrthotropicTemperature(self._Entity.GetTemperature(lookupTemperature))
def IsEffectiveLaminate(self) -> bool:
5001	def IsEffectiveLaminate(self) -> bool:
5002		'''
5003		Returns true if this material is an effective laminate.
5004		'''
5005		return self._Entity.IsEffectiveLaminate()

Returns true if this material is an effective laminate.

def HasLaminateAllowable(self, property: hyperx.api.types.AllowablePropertyName) -> bool:
5007	def HasLaminateAllowable(self, property: types.AllowablePropertyName) -> bool:
5008		return self._Entity.HasLaminateAllowable(_types.AllowablePropertyName(property.value))
def AddLaminateAllowable( self, property: hyperx.api.types.AllowablePropertyName, method: hyperx.api.types.AllowableMethodName) -> OrthotropicLaminateAllowable:
5010	def AddLaminateAllowable(self, property: types.AllowablePropertyName, method: types.AllowableMethodName) -> OrthotropicLaminateAllowable:
5011		return OrthotropicLaminateAllowable(self._Entity.AddLaminateAllowable(_types.AllowablePropertyName(property.value), _types.AllowableMethodName(method.value)))
def GetLaminateAllowable( self, lookupAllowableProperty: hyperx.api.types.AllowablePropertyName) -> OrthotropicLaminateAllowable:
5013	def GetLaminateAllowable(self, lookupAllowableProperty: types.AllowablePropertyName) -> OrthotropicLaminateAllowable:
5014		return OrthotropicLaminateAllowable(self._Entity.GetLaminateAllowable(_types.AllowablePropertyName(lookupAllowableProperty.value)))
def AddEquationCorrectionFactor( self, propertyId: hyperx.api.types.CorrectionProperty, correctionId: hyperx.api.types.CorrectionId, equationId: hyperx.api.types.CorrectionEquation) -> OrthotropicEquationCorrectionFactor:
5016	def AddEquationCorrectionFactor(self, propertyId: types.CorrectionProperty, correctionId: types.CorrectionId, equationId: types.CorrectionEquation) -> OrthotropicEquationCorrectionFactor:
5017		return OrthotropicEquationCorrectionFactor(self._Entity.AddEquationCorrectionFactor(_types.CorrectionProperty(propertyId.value), _types.CorrectionId(correctionId.value), _types.CorrectionEquation(equationId.value)))
def GetEquationCorrectionFactor( self, property: hyperx.api.types.CorrectionProperty, correction: hyperx.api.types.CorrectionId) -> OrthotropicEquationCorrectionFactor:
5019	def GetEquationCorrectionFactor(self, property: types.CorrectionProperty, correction: types.CorrectionId) -> OrthotropicEquationCorrectionFactor:
5020		return OrthotropicEquationCorrectionFactor(self._Entity.GetEquationCorrectionFactor(_types.CorrectionProperty(property.value), _types.CorrectionId(correction.value)))
def GetTabularCorrectionFactor( self, property: hyperx.api.types.CorrectionProperty, correction: hyperx.api.types.CorrectionId) -> OrthotropicTabularCorrectionFactor:
5022	def GetTabularCorrectionFactor(self, property: types.CorrectionProperty, correction: types.CorrectionId) -> OrthotropicTabularCorrectionFactor:
5023		return OrthotropicTabularCorrectionFactor(self._Entity.GetTabularCorrectionFactor(_types.CorrectionProperty(property.value), _types.CorrectionId(correction.value)))
def Save(self) -> None:
5025	def Save(self) -> None:
5026		'''
5027		Save any changes to this orthotropic material to the database.
5028		'''
5029		return self._Entity.Save()

Save any changes to this orthotropic material to the database.

class Vector2d:
5032class Vector2d:
5033	'''
5034	Represents a readonly 2D vector.
5035	'''
5036	def __init__(self, vector2d: _api.Vector2d):
5037		self._Entity = vector2d
5038
5039	def Create_Vector2d(x: float, y: float):
5040		return Vector2d(_api.Vector2d(x, y))
5041
5042	@property
5043	def X(self) -> float:
5044		return self._Entity.X
5045
5046	@property
5047	def Y(self) -> float:
5048		return self._Entity.Y
5049
5050	@overload
5051	def Equals(self, other) -> bool: ...
5052
5053	@overload
5054	def Equals(self, obj) -> bool: ...
5055
5056	def GetHashCode(self) -> int:
5057		return self._Entity.GetHashCode()
5058
5059	def Equals(self, item1 = None) -> bool:
5060		if isinstance(item1, Vector2d):
5061			return self._Entity.Equals(item1._Entity)
5062
5063		return self._Entity.Equals(item1._Entity)
5064
5065	def __eq__(self, other):
5066		return self.Equals(other)
5067
5068	def __ne__(self, other):
5069		return not self.Equals(other)

Represents a readonly 2D vector.

Vector2d(vector2d: HyperX.Scripting.Vector2d)
5036	def __init__(self, vector2d: _api.Vector2d):
5037		self._Entity = vector2d
def Create_Vector2d(x: float, y: float):
5039	def Create_Vector2d(x: float, y: float):
5040		return Vector2d(_api.Vector2d(x, y))
X: float
5042	@property
5043	def X(self) -> float:
5044		return self._Entity.X
Y: float
5046	@property
5047	def Y(self) -> float:
5048		return self._Entity.Y
def Equals(self, item1=None) -> bool:
5059	def Equals(self, item1 = None) -> bool:
5060		if isinstance(item1, Vector2d):
5061			return self._Entity.Equals(item1._Entity)
5062
5063		return self._Entity.Equals(item1._Entity)
def GetHashCode(self) -> int:
5056	def GetHashCode(self) -> int:
5057		return self._Entity.GetHashCode()
class ElementSet(IdNameEntity):
5072class ElementSet(IdNameEntity):
5073	'''
5074	A set of elements defined in the input file.
5075	'''
5076	def __init__(self, elementSet: _api.ElementSet):
5077		self._Entity = elementSet
5078
5079	@property
5080	def Elements(self) -> ElementCol:
5081		result = self._Entity.Elements
5082		return ElementCol(result) if result is not None else None

A set of elements defined in the input file.

ElementSet(elementSet: HyperX.Scripting.ElementSet)
5076	def __init__(self, elementSet: _api.ElementSet):
5077		self._Entity = elementSet
Elements: ElementCol
5079	@property
5080	def Elements(self) -> ElementCol:
5081		result = self._Entity.Elements
5082		return ElementCol(result) if result is not None else None
Inherited Members
IdNameEntity
Name
IdEntity
Id
class FemProperty(IdNameEntity):
5085class FemProperty(IdNameEntity):
5086	'''
5087	A property description.
5088	'''
5089	def __init__(self, femProperty: _api.FemProperty):
5090		self._Entity = femProperty
5091
5092	@property
5093	def Elements(self) -> ElementCol:
5094		result = self._Entity.Elements
5095		return ElementCol(result) if result is not None else None
5096
5097	@property
5098	def FemType(self) -> types.FemType:
5099		return types.FemType[self._Entity.FemType.ToString()]

A property description.

FemProperty(femProperty: HyperX.Scripting.FemProperty)
5089	def __init__(self, femProperty: _api.FemProperty):
5090		self._Entity = femProperty
Elements: ElementCol
5092	@property
5093	def Elements(self) -> ElementCol:
5094		result = self._Entity.Elements
5095		return ElementCol(result) if result is not None else None
FemType: hyperx.api.types.FemType
5097	@property
5098	def FemType(self) -> types.FemType:
5099		return types.FemType[self._Entity.FemType.ToString()]
Inherited Members
IdNameEntity
Name
IdEntity
Id
class ElementSetCol(hyperx.api.IdEntityCol[hyperx.api.ElementSet]):
5102class ElementSetCol(IdEntityCol[ElementSet]):
5103	def __init__(self, elementSetCol: _api.ElementSetCol):
5104		self._Entity = elementSetCol
5105		self._CollectedClass = ElementSet
5106
5107	@property
5108	def ElementSetColList(self) -> tuple[ElementSet]:
5109		return tuple([ElementSet(elementSetCol) for elementSetCol in self._Entity])
5110
5111	def __getitem__(self, index: int):
5112		return self.ElementSetColList[index]
5113
5114	def __iter__(self):
5115		yield from self.ElementSetColList
5116
5117	def __len__(self):
5118		return len(self.ElementSetColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

ElementSetCol(elementSetCol: HyperX.Scripting.ElementSetCol)
5103	def __init__(self, elementSetCol: _api.ElementSetCol):
5104		self._Entity = elementSetCol
5105		self._CollectedClass = ElementSet
ElementSetColList: tuple[ElementSet]
5107	@property
5108	def ElementSetColList(self) -> tuple[ElementSet]:
5109		return tuple([ElementSet(elementSetCol) for elementSetCol in self._Entity])
class FemPropertyCol(hyperx.api.IdEntityCol[hyperx.api.FemProperty]):
5121class FemPropertyCol(IdEntityCol[FemProperty]):
5122	def __init__(self, femPropertyCol: _api.FemPropertyCol):
5123		self._Entity = femPropertyCol
5124		self._CollectedClass = FemProperty
5125
5126	@property
5127	def FemPropertyColList(self) -> tuple[FemProperty]:
5128		return tuple([FemProperty(femPropertyCol) for femPropertyCol in self._Entity])
5129
5130	def __getitem__(self, index: int):
5131		return self.FemPropertyColList[index]
5132
5133	def __iter__(self):
5134		yield from self.FemPropertyColList
5135
5136	def __len__(self):
5137		return len(self.FemPropertyColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

FemPropertyCol(femPropertyCol: HyperX.Scripting.FemPropertyCol)
5122	def __init__(self, femPropertyCol: _api.FemPropertyCol):
5123		self._Entity = femPropertyCol
5124		self._CollectedClass = FemProperty
FemPropertyColList: tuple[FemProperty]
5126	@property
5127	def FemPropertyColList(self) -> tuple[FemProperty]:
5128		return tuple([FemProperty(femPropertyCol) for femPropertyCol in self._Entity])
class FemDataSet:
5140class FemDataSet:
5141	def __init__(self, femDataSet: _api.FemDataSet):
5142		self._Entity = femDataSet
5143
5144	@property
5145	def FemProperties(self) -> FemPropertyCol:
5146		result = self._Entity.FemProperties
5147		return FemPropertyCol(result) if result is not None else None
5148
5149	@property
5150	def ElementSets(self) -> ElementSetCol:
5151		result = self._Entity.ElementSets
5152		return ElementSetCol(result) if result is not None else None
FemDataSet(femDataSet: HyperX.Scripting.FemDataSet)
5141	def __init__(self, femDataSet: _api.FemDataSet):
5142		self._Entity = femDataSet
FemProperties: FemPropertyCol
5144	@property
5145	def FemProperties(self) -> FemPropertyCol:
5146		result = self._Entity.FemProperties
5147		return FemPropertyCol(result) if result is not None else None
ElementSets: ElementSetCol
5149	@property
5150	def ElementSets(self) -> ElementSetCol:
5151		result = self._Entity.ElementSets
5152		return ElementSetCol(result) if result is not None else None
class PluginPackage(IdNameEntity):
5155class PluginPackage(IdNameEntity):
5156	def __init__(self, pluginPackage: _api.PluginPackage):
5157		self._Entity = pluginPackage
5158
5159	@property
5160	def FilePath(self) -> str:
5161		return self._Entity.FilePath
5162
5163	@property
5164	def Version(self) -> str:
5165		return self._Entity.Version
5166
5167	@property
5168	def Description(self) -> str:
5169		return self._Entity.Description
5170
5171	@property
5172	def ModificationDate(self) -> DateTime:
5173		return self._Entity.ModificationDate

Represents an entity with an ID and Name.

PluginPackage(pluginPackage: HyperX.Scripting.PluginPackage)
5156	def __init__(self, pluginPackage: _api.PluginPackage):
5157		self._Entity = pluginPackage
FilePath: str
5159	@property
5160	def FilePath(self) -> str:
5161		return self._Entity.FilePath
Version: str
5163	@property
5164	def Version(self) -> str:
5165		return self._Entity.Version
Description: str
5167	@property
5168	def Description(self) -> str:
5169		return self._Entity.Description
ModificationDate: System.DateTime
5171	@property
5172	def ModificationDate(self) -> DateTime:
5173		return self._Entity.ModificationDate
Inherited Members
IdNameEntity
Name
IdEntity
Id
class Ply(IdNameEntity):
5176class Ply(IdNameEntity):
5177	def __init__(self, ply: _api.Ply):
5178		self._Entity = ply
5179
5180	@property
5181	def InnerCurves(self) -> list[int]:
5182		return [int32 for int32 in self._Entity.InnerCurves]
5183
5184	@property
5185	def OuterCurves(self) -> list[int]:
5186		return [int32 for int32 in self._Entity.OuterCurves]
5187
5188	@property
5189	def FiberDirectionCurves(self) -> list[int]:
5190		return [int32 for int32 in self._Entity.FiberDirectionCurves]
5191
5192	@property
5193	def Area(self) -> float:
5194		return self._Entity.Area
5195
5196	@property
5197	def Description(self) -> str:
5198		return self._Entity.Description
5199
5200	@property
5201	def Elements(self) -> ElementCol:
5202		result = self._Entity.Elements
5203		return ElementCol(result) if result is not None else None
5204
5205	@property
5206	def MaterialId(self) -> int:
5207		return self._Entity.MaterialId
5208
5209	@property
5210	def Orientation(self) -> int:
5211		return self._Entity.Orientation
5212
5213	@property
5214	def Sequence(self) -> int:
5215		return self._Entity.Sequence
5216
5217	@property
5218	def StructureId(self) -> int:
5219		return self._Entity.StructureId
5220
5221	@property
5222	def Thickness(self) -> float:
5223		return self._Entity.Thickness

Represents an entity with an ID and Name.

Ply(ply: HyperX.Scripting.Ply)
5177	def __init__(self, ply: _api.Ply):
5178		self._Entity = ply
InnerCurves: list[int]
5180	@property
5181	def InnerCurves(self) -> list[int]:
5182		return [int32 for int32 in self._Entity.InnerCurves]
OuterCurves: list[int]
5184	@property
5185	def OuterCurves(self) -> list[int]:
5186		return [int32 for int32 in self._Entity.OuterCurves]
FiberDirectionCurves: list[int]
5188	@property
5189	def FiberDirectionCurves(self) -> list[int]:
5190		return [int32 for int32 in self._Entity.FiberDirectionCurves]
Area: float
5192	@property
5193	def Area(self) -> float:
5194		return self._Entity.Area
Description: str
5196	@property
5197	def Description(self) -> str:
5198		return self._Entity.Description
Elements: ElementCol
5200	@property
5201	def Elements(self) -> ElementCol:
5202		result = self._Entity.Elements
5203		return ElementCol(result) if result is not None else None
MaterialId: int
5205	@property
5206	def MaterialId(self) -> int:
5207		return self._Entity.MaterialId
Orientation: int
5209	@property
5210	def Orientation(self) -> int:
5211		return self._Entity.Orientation
Sequence: int
5213	@property
5214	def Sequence(self) -> int:
5215		return self._Entity.Sequence
StructureId: int
5217	@property
5218	def StructureId(self) -> int:
5219		return self._Entity.StructureId
Thickness: float
5221	@property
5222	def Thickness(self) -> float:
5223		return self._Entity.Thickness
Inherited Members
IdNameEntity
Name
IdEntity
Id
class Rundeck(IdEntity):
5226class Rundeck(IdEntity):
5227	def __init__(self, rundeck: _api.Rundeck):
5228		self._Entity = rundeck
5229
5230	@property
5231	def InputFilePath(self) -> str:
5232		return self._Entity.InputFilePath
5233
5234	@property
5235	def IsPrimary(self) -> bool:
5236		return self._Entity.IsPrimary
5237
5238	@property
5239	def ResultFilePath(self) -> str:
5240		return self._Entity.ResultFilePath
5241
5242	def SetInputFilePath(self, filepath: str) -> RundeckUpdateStatus:
5243		return RundeckUpdateStatus[self._Entity.SetInputFilePath(filepath).ToString()]
5244
5245	def SetResultFilePath(self, filepath: str) -> RundeckUpdateStatus:
5246		return RundeckUpdateStatus[self._Entity.SetResultFilePath(filepath).ToString()]

Represents an entity with an ID.

Rundeck(rundeck: HyperX.Scripting.Rundeck)
5227	def __init__(self, rundeck: _api.Rundeck):
5228		self._Entity = rundeck
InputFilePath: str
5230	@property
5231	def InputFilePath(self) -> str:
5232		return self._Entity.InputFilePath
IsPrimary: bool
5234	@property
5235	def IsPrimary(self) -> bool:
5236		return self._Entity.IsPrimary
ResultFilePath: str
5238	@property
5239	def ResultFilePath(self) -> str:
5240		return self._Entity.ResultFilePath
def SetInputFilePath(self, filepath: str) -> RundeckUpdateStatus:
5242	def SetInputFilePath(self, filepath: str) -> RundeckUpdateStatus:
5243		return RundeckUpdateStatus[self._Entity.SetInputFilePath(filepath).ToString()]
def SetResultFilePath(self, filepath: str) -> RundeckUpdateStatus:
5245	def SetResultFilePath(self, filepath: str) -> RundeckUpdateStatus:
5246		return RundeckUpdateStatus[self._Entity.SetResultFilePath(filepath).ToString()]
Inherited Members
IdEntity
Id
class RundeckPathPair:
5249class RundeckPathPair:
5250	def __init__(self, rundeckPathPair: _api.RundeckPathPair):
5251		self._Entity = rundeckPathPair
5252
5253	@property
5254	def InputFilePath(self) -> str:
5255		return self._Entity.InputFilePath
5256
5257	@property
5258	def ResultFilePath(self) -> str:
5259		return self._Entity.ResultFilePath
5260
5261	@InputFilePath.setter
5262	def InputFilePath(self, value: str) -> None:
5263		self._Entity.InputFilePath = value
5264
5265	@ResultFilePath.setter
5266	def ResultFilePath(self, value: str) -> None:
5267		self._Entity.ResultFilePath = value
RundeckPathPair(rundeckPathPair: HyperX.Scripting.RundeckPathPair)
5250	def __init__(self, rundeckPathPair: _api.RundeckPathPair):
5251		self._Entity = rundeckPathPair
InputFilePath: str
5253	@property
5254	def InputFilePath(self) -> str:
5255		return self._Entity.InputFilePath
ResultFilePath: str
5257	@property
5258	def ResultFilePath(self) -> str:
5259		return self._Entity.ResultFilePath
class BeamLoads:
5270class BeamLoads:
5271	def __init__(self, beamLoads: _api.BeamLoads):
5272		self._Entity = beamLoads
5273
5274	@property
5275	def AxialForce(self) -> float:
5276		return self._Entity.AxialForce
5277
5278	@property
5279	def MomentX(self) -> float:
5280		return self._Entity.MomentX
5281
5282	@property
5283	def MomentY(self) -> float:
5284		return self._Entity.MomentY
5285
5286	@property
5287	def ShearX(self) -> float:
5288		return self._Entity.ShearX
5289
5290	@property
5291	def ShearY(self) -> float:
5292		return self._Entity.ShearY
5293
5294	@property
5295	def Torque(self) -> float:
5296		return self._Entity.Torque
BeamLoads(beamLoads: HyperX.Scripting.BeamLoads)
5271	def __init__(self, beamLoads: _api.BeamLoads):
5272		self._Entity = beamLoads
AxialForce: float
5274	@property
5275	def AxialForce(self) -> float:
5276		return self._Entity.AxialForce
MomentX: float
5278	@property
5279	def MomentX(self) -> float:
5280		return self._Entity.MomentX
MomentY: float
5282	@property
5283	def MomentY(self) -> float:
5284		return self._Entity.MomentY
ShearX: float
5286	@property
5287	def ShearX(self) -> float:
5288		return self._Entity.ShearX
ShearY: float
5290	@property
5291	def ShearY(self) -> float:
5292		return self._Entity.ShearY
Torque: float
5294	@property
5295	def Torque(self) -> float:
5296		return self._Entity.Torque
class SectionCut(IdNameEntity):
5299class SectionCut(IdNameEntity):
5300	def __init__(self, sectionCut: _api.SectionCut):
5301		self._Entity = sectionCut
5302
5303	@property
5304	def ReferencePoint(self) -> types.SectionCutPropertyLocation:
5305		'''
5306		Centroid vs Origin
5307		'''
5308		return types.SectionCutPropertyLocation[self._Entity.ReferencePoint.ToString()]
5309
5310	@property
5311	def HorizontalVector(self) -> Vector3d:
5312		'''
5313		Represents a readonly 3D vector.
5314		'''
5315		result = self._Entity.HorizontalVector
5316		return Vector3d(result) if result is not None else None
5317
5318	@property
5319	def NormalVector(self) -> Vector3d:
5320		'''
5321		Represents a readonly 3D vector.
5322		'''
5323		result = self._Entity.NormalVector
5324		return Vector3d(result) if result is not None else None
5325
5326	@property
5327	def OriginVector(self) -> Vector3d:
5328		'''
5329		Represents a readonly 3D vector.
5330		'''
5331		result = self._Entity.OriginVector
5332		return Vector3d(result) if result is not None else None
5333
5334	@property
5335	def VerticalVector(self) -> Vector3d:
5336		'''
5337		Represents a readonly 3D vector.
5338		'''
5339		result = self._Entity.VerticalVector
5340		return Vector3d(result) if result is not None else None
5341
5342	@property
5343	def MaxAngleBound(self) -> float:
5344		return self._Entity.MaxAngleBound
5345
5346	@property
5347	def MinAngleBound(self) -> float:
5348		return self._Entity.MinAngleBound
5349
5350	@property
5351	def MinStiffnessEihh(self) -> float:
5352		return self._Entity.MinStiffnessEihh
5353
5354	@property
5355	def MinStiffnessEivv(self) -> float:
5356		return self._Entity.MinStiffnessEivv
5357
5358	@property
5359	def MinStiffnessGJ(self) -> float:
5360		return self._Entity.MinStiffnessGJ
5361
5362	@property
5363	def ZoneStiffnessDistribution(self) -> float:
5364		return self._Entity.ZoneStiffnessDistribution
5365
5366	@property
5367	def CN_hmax(self) -> float:
5368		return self._Entity.CN_hmax
5369
5370	@property
5371	def CN_hmin(self) -> float:
5372		return self._Entity.CN_hmin
5373
5374	@property
5375	def CN_vmax(self) -> float:
5376		return self._Entity.CN_vmax
5377
5378	@property
5379	def CN_vmin(self) -> float:
5380		return self._Entity.CN_vmin
5381
5382	@property
5383	def CQ_hmax(self) -> float:
5384		return self._Entity.CQ_hmax
5385
5386	@property
5387	def CQ_hmin(self) -> float:
5388		return self._Entity.CQ_hmin
5389
5390	@property
5391	def CQ_vmax(self) -> float:
5392		return self._Entity.CQ_vmax
5393
5394	@property
5395	def CQ_vmin(self) -> float:
5396		return self._Entity.CQ_vmin
5397
5398	@property
5399	def CG(self) -> Vector2d:
5400		'''
5401		Represents a readonly 2D vector.
5402		'''
5403		result = self._Entity.CG
5404		return Vector2d(result) if result is not None else None
5405
5406	@property
5407	def CN(self) -> Vector2d:
5408		'''
5409		Represents a readonly 2D vector.
5410		'''
5411		result = self._Entity.CN
5412		return Vector2d(result) if result is not None else None
5413
5414	@property
5415	def CQ(self) -> Vector2d:
5416		'''
5417		Represents a readonly 2D vector.
5418		'''
5419		result = self._Entity.CQ
5420		return Vector2d(result) if result is not None else None
5421
5422	@property
5423	def EnclosedArea(self) -> float:
5424		return self._Entity.EnclosedArea
5425
5426	@property
5427	def NumberOfCells(self) -> int:
5428		return self._Entity.NumberOfCells
5429
5430	@property
5431	def EIhh(self) -> float:
5432		return self._Entity.EIhh
5433
5434	@property
5435	def EIhv(self) -> float:
5436		return self._Entity.EIhv
5437
5438	@property
5439	def EIvv(self) -> float:
5440		return self._Entity.EIvv
5441
5442	@property
5443	def GJ(self) -> float:
5444		return self._Entity.GJ
5445
5446	@property
5447	def EA(self) -> float:
5448		return self._Entity.EA
5449
5450	@property
5451	def EImax(self) -> float:
5452		return self._Entity.EImax
5453
5454	@property
5455	def EImin(self) -> float:
5456		return self._Entity.EImin
5457
5458	@property
5459	def PrincipalAngle(self) -> float:
5460		return self._Entity.PrincipalAngle
5461
5462	@property
5463	def Elements(self) -> ElementCol:
5464		result = self._Entity.Elements
5465		return ElementCol(result) if result is not None else None
5466
5467	@property
5468	def PlateElements(self) -> ElementCol:
5469		result = self._Entity.PlateElements
5470		return ElementCol(result) if result is not None else None
5471
5472	@property
5473	def BeamElements(self) -> ElementCol:
5474		result = self._Entity.BeamElements
5475		return ElementCol(result) if result is not None else None
5476
5477	@ReferencePoint.setter
5478	def ReferencePoint(self, value: types.SectionCutPropertyLocation) -> None:
5479		self._Entity.ReferencePoint = _types.SectionCutPropertyLocation(value.value)
5480
5481	@MaxAngleBound.setter
5482	def MaxAngleBound(self, value: float) -> None:
5483		self._Entity.MaxAngleBound = value
5484
5485	@MinAngleBound.setter
5486	def MinAngleBound(self, value: float) -> None:
5487		self._Entity.MinAngleBound = value
5488
5489	@MinStiffnessEihh.setter
5490	def MinStiffnessEihh(self, value: float) -> None:
5491		self._Entity.MinStiffnessEihh = value
5492
5493	@MinStiffnessEivv.setter
5494	def MinStiffnessEivv(self, value: float) -> None:
5495		self._Entity.MinStiffnessEivv = value
5496
5497	@MinStiffnessGJ.setter
5498	def MinStiffnessGJ(self, value: float) -> None:
5499		self._Entity.MinStiffnessGJ = value
5500
5501	@ZoneStiffnessDistribution.setter
5502	def ZoneStiffnessDistribution(self, value: float) -> None:
5503		self._Entity.ZoneStiffnessDistribution = value
5504
5505	@CN_hmax.setter
5506	def CN_hmax(self, value: float) -> None:
5507		self._Entity.CN_hmax = value
5508
5509	@CN_hmin.setter
5510	def CN_hmin(self, value: float) -> None:
5511		self._Entity.CN_hmin = value
5512
5513	@CN_vmax.setter
5514	def CN_vmax(self, value: float) -> None:
5515		self._Entity.CN_vmax = value
5516
5517	@CN_vmin.setter
5518	def CN_vmin(self, value: float) -> None:
5519		self._Entity.CN_vmin = value
5520
5521	@CQ_hmax.setter
5522	def CQ_hmax(self, value: float) -> None:
5523		self._Entity.CQ_hmax = value
5524
5525	@CQ_hmin.setter
5526	def CQ_hmin(self, value: float) -> None:
5527		self._Entity.CQ_hmin = value
5528
5529	@CQ_vmax.setter
5530	def CQ_vmax(self, value: float) -> None:
5531		self._Entity.CQ_vmax = value
5532
5533	@CQ_vmin.setter
5534	def CQ_vmin(self, value: float) -> None:
5535		self._Entity.CQ_vmin = value
5536
5537	def AlignToHorizontalPrincipalAxes(self) -> None:
5538		'''
5539		Set this Section Cut's horizontal vector to be equal to its principal axis horizontal vector.
5540		'''
5541		return self._Entity.AlignToHorizontalPrincipalAxes()
5542
5543	def AlignToVerticalPrincipalAxes(self) -> None:
5544		'''
5545		Set this Section Cut's horizontal vector to be equal to its principal axis vertical vector.
5546		'''
5547		return self._Entity.AlignToVerticalPrincipalAxes()
5548
5549	def SetHorizontalVector(self, vector: Vector3d) -> None:
5550		return self._Entity.SetHorizontalVector(vector._Entity)
5551
5552	def SetNormalVector(self, vector: Vector3d) -> None:
5553		return self._Entity.SetNormalVector(vector._Entity)
5554
5555	def SetOrigin(self, vector: Vector3d) -> None:
5556		return self._Entity.SetOrigin(vector._Entity)
5557
5558	def GetBeamLoads(self, loadCaseId: int, factor: types.LoadSubCaseFactor) -> BeamLoads:
5559		return BeamLoads(self._Entity.GetBeamLoads(loadCaseId, _types.LoadSubCaseFactor(factor.value)))
5560
5561	def InclinationAngle(self, loadCaseId: int, factor: types.LoadSubCaseFactor) -> float:
5562		return self._Entity.InclinationAngle(loadCaseId, _types.LoadSubCaseFactor(factor.value))
5563
5564	def HorizontalIntercept(self, loadCaseId: int, factor: types.LoadSubCaseFactor) -> float:
5565		return self._Entity.HorizontalIntercept(loadCaseId, _types.LoadSubCaseFactor(factor.value))
5566
5567	def VerticalIntercept(self, loadCaseId: int, factor: types.LoadSubCaseFactor) -> float:
5568		return self._Entity.VerticalIntercept(loadCaseId, _types.LoadSubCaseFactor(factor.value))
5569
5570	def SetElements(self, elements: list[int]) -> bool:
5571		elementsList = MakeCSharpIntList(elements)
5572		return self._Entity.SetElements(elementsList)
5573
5574	def SetElementsByIntersection(self) -> None:
5575		return self._Entity.SetElementsByIntersection()

Represents an entity with an ID and Name.

SectionCut(sectionCut: HyperX.Scripting.SectionCut)
5300	def __init__(self, sectionCut: _api.SectionCut):
5301		self._Entity = sectionCut
ReferencePoint: hyperx.api.types.SectionCutPropertyLocation
5303	@property
5304	def ReferencePoint(self) -> types.SectionCutPropertyLocation:
5305		'''
5306		Centroid vs Origin
5307		'''
5308		return types.SectionCutPropertyLocation[self._Entity.ReferencePoint.ToString()]

Centroid vs Origin

HorizontalVector: Vector3d
5310	@property
5311	def HorizontalVector(self) -> Vector3d:
5312		'''
5313		Represents a readonly 3D vector.
5314		'''
5315		result = self._Entity.HorizontalVector
5316		return Vector3d(result) if result is not None else None

Represents a readonly 3D vector.

NormalVector: Vector3d
5318	@property
5319	def NormalVector(self) -> Vector3d:
5320		'''
5321		Represents a readonly 3D vector.
5322		'''
5323		result = self._Entity.NormalVector
5324		return Vector3d(result) if result is not None else None

Represents a readonly 3D vector.

OriginVector: Vector3d
5326	@property
5327	def OriginVector(self) -> Vector3d:
5328		'''
5329		Represents a readonly 3D vector.
5330		'''
5331		result = self._Entity.OriginVector
5332		return Vector3d(result) if result is not None else None

Represents a readonly 3D vector.

VerticalVector: Vector3d
5334	@property
5335	def VerticalVector(self) -> Vector3d:
5336		'''
5337		Represents a readonly 3D vector.
5338		'''
5339		result = self._Entity.VerticalVector
5340		return Vector3d(result) if result is not None else None

Represents a readonly 3D vector.

MaxAngleBound: float
5342	@property
5343	def MaxAngleBound(self) -> float:
5344		return self._Entity.MaxAngleBound
MinAngleBound: float
5346	@property
5347	def MinAngleBound(self) -> float:
5348		return self._Entity.MinAngleBound
MinStiffnessEihh: float
5350	@property
5351	def MinStiffnessEihh(self) -> float:
5352		return self._Entity.MinStiffnessEihh
MinStiffnessEivv: float
5354	@property
5355	def MinStiffnessEivv(self) -> float:
5356		return self._Entity.MinStiffnessEivv
MinStiffnessGJ: float
5358	@property
5359	def MinStiffnessGJ(self) -> float:
5360		return self._Entity.MinStiffnessGJ
ZoneStiffnessDistribution: float
5362	@property
5363	def ZoneStiffnessDistribution(self) -> float:
5364		return self._Entity.ZoneStiffnessDistribution
CN_hmax: float
5366	@property
5367	def CN_hmax(self) -> float:
5368		return self._Entity.CN_hmax
CN_hmin: float
5370	@property
5371	def CN_hmin(self) -> float:
5372		return self._Entity.CN_hmin
CN_vmax: float
5374	@property
5375	def CN_vmax(self) -> float:
5376		return self._Entity.CN_vmax
CN_vmin: float
5378	@property
5379	def CN_vmin(self) -> float:
5380		return self._Entity.CN_vmin
CQ_hmax: float
5382	@property
5383	def CQ_hmax(self) -> float:
5384		return self._Entity.CQ_hmax
CQ_hmin: float
5386	@property
5387	def CQ_hmin(self) -> float:
5388		return self._Entity.CQ_hmin
CQ_vmax: float
5390	@property
5391	def CQ_vmax(self) -> float:
5392		return self._Entity.CQ_vmax
CQ_vmin: float
5394	@property
5395	def CQ_vmin(self) -> float:
5396		return self._Entity.CQ_vmin
CG: Vector2d
5398	@property
5399	def CG(self) -> Vector2d:
5400		'''
5401		Represents a readonly 2D vector.
5402		'''
5403		result = self._Entity.CG
5404		return Vector2d(result) if result is not None else None

Represents a readonly 2D vector.

CN: Vector2d
5406	@property
5407	def CN(self) -> Vector2d:
5408		'''
5409		Represents a readonly 2D vector.
5410		'''
5411		result = self._Entity.CN
5412		return Vector2d(result) if result is not None else None

Represents a readonly 2D vector.

CQ: Vector2d
5414	@property
5415	def CQ(self) -> Vector2d:
5416		'''
5417		Represents a readonly 2D vector.
5418		'''
5419		result = self._Entity.CQ
5420		return Vector2d(result) if result is not None else None

Represents a readonly 2D vector.

EnclosedArea: float
5422	@property
5423	def EnclosedArea(self) -> float:
5424		return self._Entity.EnclosedArea
NumberOfCells: int
5426	@property
5427	def NumberOfCells(self) -> int:
5428		return self._Entity.NumberOfCells
EIhh: float
5430	@property
5431	def EIhh(self) -> float:
5432		return self._Entity.EIhh
EIhv: float
5434	@property
5435	def EIhv(self) -> float:
5436		return self._Entity.EIhv
EIvv: float
5438	@property
5439	def EIvv(self) -> float:
5440		return self._Entity.EIvv
GJ: float
5442	@property
5443	def GJ(self) -> float:
5444		return self._Entity.GJ
EA: float
5446	@property
5447	def EA(self) -> float:
5448		return self._Entity.EA
EImax: float
5450	@property
5451	def EImax(self) -> float:
5452		return self._Entity.EImax
EImin: float
5454	@property
5455	def EImin(self) -> float:
5456		return self._Entity.EImin
PrincipalAngle: float
5458	@property
5459	def PrincipalAngle(self) -> float:
5460		return self._Entity.PrincipalAngle
Elements: ElementCol
5462	@property
5463	def Elements(self) -> ElementCol:
5464		result = self._Entity.Elements
5465		return ElementCol(result) if result is not None else None
PlateElements: ElementCol
5467	@property
5468	def PlateElements(self) -> ElementCol:
5469		result = self._Entity.PlateElements
5470		return ElementCol(result) if result is not None else None
BeamElements: ElementCol
5472	@property
5473	def BeamElements(self) -> ElementCol:
5474		result = self._Entity.BeamElements
5475		return ElementCol(result) if result is not None else None
def AlignToHorizontalPrincipalAxes(self) -> None:
5537	def AlignToHorizontalPrincipalAxes(self) -> None:
5538		'''
5539		Set this Section Cut's horizontal vector to be equal to its principal axis horizontal vector.
5540		'''
5541		return self._Entity.AlignToHorizontalPrincipalAxes()

Set this Section Cut's horizontal vector to be equal to its principal axis horizontal vector.

def AlignToVerticalPrincipalAxes(self) -> None:
5543	def AlignToVerticalPrincipalAxes(self) -> None:
5544		'''
5545		Set this Section Cut's horizontal vector to be equal to its principal axis vertical vector.
5546		'''
5547		return self._Entity.AlignToVerticalPrincipalAxes()

Set this Section Cut's horizontal vector to be equal to its principal axis vertical vector.

def SetHorizontalVector(self, vector: Vector3d) -> None:
5549	def SetHorizontalVector(self, vector: Vector3d) -> None:
5550		return self._Entity.SetHorizontalVector(vector._Entity)
def SetNormalVector(self, vector: Vector3d) -> None:
5552	def SetNormalVector(self, vector: Vector3d) -> None:
5553		return self._Entity.SetNormalVector(vector._Entity)
def SetOrigin(self, vector: Vector3d) -> None:
5555	def SetOrigin(self, vector: Vector3d) -> None:
5556		return self._Entity.SetOrigin(vector._Entity)
def GetBeamLoads( self, loadCaseId: int, factor: hyperx.api.types.LoadSubCaseFactor) -> BeamLoads:
5558	def GetBeamLoads(self, loadCaseId: int, factor: types.LoadSubCaseFactor) -> BeamLoads:
5559		return BeamLoads(self._Entity.GetBeamLoads(loadCaseId, _types.LoadSubCaseFactor(factor.value)))
def InclinationAngle( self, loadCaseId: int, factor: hyperx.api.types.LoadSubCaseFactor) -> float:
5561	def InclinationAngle(self, loadCaseId: int, factor: types.LoadSubCaseFactor) -> float:
5562		return self._Entity.InclinationAngle(loadCaseId, _types.LoadSubCaseFactor(factor.value))
def HorizontalIntercept( self, loadCaseId: int, factor: hyperx.api.types.LoadSubCaseFactor) -> float:
5564	def HorizontalIntercept(self, loadCaseId: int, factor: types.LoadSubCaseFactor) -> float:
5565		return self._Entity.HorizontalIntercept(loadCaseId, _types.LoadSubCaseFactor(factor.value))
def VerticalIntercept( self, loadCaseId: int, factor: hyperx.api.types.LoadSubCaseFactor) -> float:
5567	def VerticalIntercept(self, loadCaseId: int, factor: types.LoadSubCaseFactor) -> float:
5568		return self._Entity.VerticalIntercept(loadCaseId, _types.LoadSubCaseFactor(factor.value))
def SetElements(self, elements: list[int]) -> bool:
5570	def SetElements(self, elements: list[int]) -> bool:
5571		elementsList = MakeCSharpIntList(elements)
5572		return self._Entity.SetElements(elementsList)
def SetElementsByIntersection(self) -> None:
5574	def SetElementsByIntersection(self) -> None:
5575		return self._Entity.SetElementsByIntersection()
Inherited Members
IdNameEntity
Name
IdEntity
Id
class Set(ZoneJointContainer):
5578class Set(ZoneJointContainer):
5579	def __init__(self, set: _api.Set):
5580		self._Entity = set
5581
5582	@property
5583	def Joints(self) -> JointCol:
5584		result = self._Entity.Joints
5585		return JointCol(result) if result is not None else None
5586
5587	@property
5588	def PanelSegments(self) -> PanelSegmentCol:
5589		result = self._Entity.PanelSegments
5590		return PanelSegmentCol(result) if result is not None else None
5591
5592	@property
5593	def Zones(self) -> ZoneCol:
5594		result = self._Entity.Zones
5595		return ZoneCol(result) if result is not None else None
5596
5597	@overload
5598	def AddJoint(self, joint: Joint) -> CollectionModificationStatus: ...
5599
5600	@overload
5601	def AddPanelSegment(self, segment: PanelSegment) -> CollectionModificationStatus: ...
5602
5603	@overload
5604	def AddZones(self, zones: tuple[Zone]) -> CollectionModificationStatus: ...
5605
5606	@overload
5607	def RemoveJoints(self, jointIds: tuple[int]) -> CollectionModificationStatus: ...
5608
5609	@overload
5610	def RemovePanelSegments(self, segmentIds: tuple[int]) -> CollectionModificationStatus: ...
5611
5612	@overload
5613	def RemoveZones(self, zoneIds: tuple[int]) -> CollectionModificationStatus: ...
5614
5615	@overload
5616	def AddJoint(self, id: int) -> CollectionModificationStatus: ...
5617
5618	@overload
5619	def RemoveJoint(self, id: int) -> CollectionModificationStatus: ...
5620
5621	@overload
5622	def RemoveJoint(self, joint: Joint) -> CollectionModificationStatus: ...
5623
5624	@overload
5625	def RemoveJoints(self, joints: JointCol) -> CollectionModificationStatus: ...
5626
5627	@overload
5628	def AddZone(self, id: int) -> CollectionModificationStatus: ...
5629
5630	@overload
5631	def AddZones(self, ids: tuple[int]) -> CollectionModificationStatus: ...
5632
5633	@overload
5634	def AddZone(self, zone: Zone) -> CollectionModificationStatus: ...
5635
5636	@overload
5637	def RemoveZone(self, id: int) -> CollectionModificationStatus: ...
5638
5639	@overload
5640	def RemoveZone(self, zone: Zone) -> CollectionModificationStatus: ...
5641
5642	@overload
5643	def RemoveZones(self, zones: ZoneCol) -> CollectionModificationStatus: ...
5644
5645	@overload
5646	def AddPanelSegment(self, id: int) -> CollectionModificationStatus: ...
5647
5648	@overload
5649	def RemovePanelSegment(self, id: int) -> CollectionModificationStatus: ...
5650
5651	@overload
5652	def RemovePanelSegment(self, segment: PanelSegment) -> CollectionModificationStatus: ...
5653
5654	@overload
5655	def RemovePanelSegments(self, segments: PanelSegmentCol) -> CollectionModificationStatus: ...
5656
5657	def AddJoint(self, item1 = None) -> CollectionModificationStatus:
5658		if isinstance(item1, Joint):
5659			return CollectionModificationStatus[self._Entity.AddJoint(item1._Entity).ToString()]
5660
5661		if isinstance(item1, int):
5662			return CollectionModificationStatus(super().AddJoint(item1))
5663
5664		return CollectionModificationStatus[self._Entity.AddJoint(item1._Entity).ToString()]
5665
5666	def AddPanelSegment(self, item1 = None) -> CollectionModificationStatus:
5667		if isinstance(item1, PanelSegment):
5668			return CollectionModificationStatus[self._Entity.AddPanelSegment(item1._Entity).ToString()]
5669
5670		if isinstance(item1, int):
5671			return CollectionModificationStatus(super().AddPanelSegment(item1))
5672
5673		return CollectionModificationStatus[self._Entity.AddPanelSegment(item1._Entity).ToString()]
5674
5675	def AddZones(self, item1 = None) -> CollectionModificationStatus:
5676		if isinstance(item1, tuple) and item1 and isinstance(item1[0], Zone):
5677			zonesList = List[_api.Zone]()
5678			if item1 is not None:
5679				for thing in item1:
5680					if thing is not None:
5681						zonesList.Add(thing._Entity)
5682			zonesEnumerable = IEnumerable(zonesList)
5683			return CollectionModificationStatus[self._Entity.AddZones(zonesEnumerable).ToString()]
5684
5685		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
5686			return CollectionModificationStatus(super().AddZones(item1))
5687
5688		return CollectionModificationStatus[self._Entity.AddZones(item1).ToString()]
5689
5690	def RemoveJoints(self, item1 = None) -> CollectionModificationStatus:
5691		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
5692			jointIdsList = MakeCSharpIntList(item1)
5693			jointIdsEnumerable = IEnumerable(jointIdsList)
5694			return CollectionModificationStatus[self._Entity.RemoveJoints(jointIdsEnumerable).ToString()]
5695
5696		if isinstance(item1, JointCol):
5697			return CollectionModificationStatus(super().RemoveJoints(item1))
5698
5699		return CollectionModificationStatus[self._Entity.RemoveJoints(item1).ToString()]
5700
5701	def RemovePanelSegments(self, item1 = None) -> CollectionModificationStatus:
5702		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
5703			segmentIdsList = MakeCSharpIntList(item1)
5704			segmentIdsEnumerable = IEnumerable(segmentIdsList)
5705			return CollectionModificationStatus[self._Entity.RemovePanelSegments(segmentIdsEnumerable).ToString()]
5706
5707		if isinstance(item1, PanelSegmentCol):
5708			return CollectionModificationStatus(super().RemovePanelSegments(item1))
5709
5710		return CollectionModificationStatus[self._Entity.RemovePanelSegments(item1).ToString()]
5711
5712	def RemoveZones(self, item1 = None) -> CollectionModificationStatus:
5713		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
5714			zoneIdsList = MakeCSharpIntList(item1)
5715			zoneIdsEnumerable = IEnumerable(zoneIdsList)
5716			return CollectionModificationStatus[self._Entity.RemoveZones(zoneIdsEnumerable).ToString()]
5717
5718		if isinstance(item1, ZoneCol):
5719			return CollectionModificationStatus(super().RemoveZones(item1))
5720
5721		return CollectionModificationStatus[self._Entity.RemoveZones(item1).ToString()]
5722
5723	def RemoveJoint(self, item1 = None) -> CollectionModificationStatus:
5724		if isinstance(item1, int):
5725			return CollectionModificationStatus(super().RemoveJoint(item1))
5726
5727		if isinstance(item1, Joint):
5728			return CollectionModificationStatus(super().RemoveJoint(item1))
5729
5730		return CollectionModificationStatus[self._Entity.RemoveJoint(item1).ToString()]
5731
5732	def AddZone(self, item1 = None) -> CollectionModificationStatus:
5733		if isinstance(item1, int):
5734			return CollectionModificationStatus(super().AddZone(item1))
5735
5736		if isinstance(item1, Zone):
5737			return CollectionModificationStatus(super().AddZone(item1))
5738
5739		return CollectionModificationStatus[self._Entity.AddZone(item1).ToString()]
5740
5741	def RemoveZone(self, item1 = None) -> CollectionModificationStatus:
5742		if isinstance(item1, int):
5743			return CollectionModificationStatus(super().RemoveZone(item1))
5744
5745		if isinstance(item1, Zone):
5746			return CollectionModificationStatus(super().RemoveZone(item1))
5747
5748		return CollectionModificationStatus[self._Entity.RemoveZone(item1).ToString()]
5749
5750	def RemovePanelSegment(self, item1 = None) -> CollectionModificationStatus:
5751		if isinstance(item1, int):
5752			return CollectionModificationStatus(super().RemovePanelSegment(item1))
5753
5754		if isinstance(item1, PanelSegment):
5755			return CollectionModificationStatus(super().RemovePanelSegment(item1))
5756
5757		return CollectionModificationStatus[self._Entity.RemovePanelSegment(item1).ToString()]

Represents an entity that contains a collection of Zones and Joints.

Set(set: HyperX.Scripting.Set)
5579	def __init__(self, set: _api.Set):
5580		self._Entity = set
Joints: JointCol
5582	@property
5583	def Joints(self) -> JointCol:
5584		result = self._Entity.Joints
5585		return JointCol(result) if result is not None else None
PanelSegments: PanelSegmentCol
5587	@property
5588	def PanelSegments(self) -> PanelSegmentCol:
5589		result = self._Entity.PanelSegments
5590		return PanelSegmentCol(result) if result is not None else None
Zones: ZoneCol
5592	@property
5593	def Zones(self) -> ZoneCol:
5594		result = self._Entity.Zones
5595		return ZoneCol(result) if result is not None else None
def AddJoint(self, item1=None) -> CollectionModificationStatus:
5657	def AddJoint(self, item1 = None) -> CollectionModificationStatus:
5658		if isinstance(item1, Joint):
5659			return CollectionModificationStatus[self._Entity.AddJoint(item1._Entity).ToString()]
5660
5661		if isinstance(item1, int):
5662			return CollectionModificationStatus(super().AddJoint(item1))
5663
5664		return CollectionModificationStatus[self._Entity.AddJoint(item1._Entity).ToString()]
def AddPanelSegment(self, item1=None) -> CollectionModificationStatus:
5666	def AddPanelSegment(self, item1 = None) -> CollectionModificationStatus:
5667		if isinstance(item1, PanelSegment):
5668			return CollectionModificationStatus[self._Entity.AddPanelSegment(item1._Entity).ToString()]
5669
5670		if isinstance(item1, int):
5671			return CollectionModificationStatus(super().AddPanelSegment(item1))
5672
5673		return CollectionModificationStatus[self._Entity.AddPanelSegment(item1._Entity).ToString()]
def AddZones(self, item1=None) -> CollectionModificationStatus:
5675	def AddZones(self, item1 = None) -> CollectionModificationStatus:
5676		if isinstance(item1, tuple) and item1 and isinstance(item1[0], Zone):
5677			zonesList = List[_api.Zone]()
5678			if item1 is not None:
5679				for thing in item1:
5680					if thing is not None:
5681						zonesList.Add(thing._Entity)
5682			zonesEnumerable = IEnumerable(zonesList)
5683			return CollectionModificationStatus[self._Entity.AddZones(zonesEnumerable).ToString()]
5684
5685		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
5686			return CollectionModificationStatus(super().AddZones(item1))
5687
5688		return CollectionModificationStatus[self._Entity.AddZones(item1).ToString()]
def RemoveJoints(self, item1=None) -> CollectionModificationStatus:
5690	def RemoveJoints(self, item1 = None) -> CollectionModificationStatus:
5691		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
5692			jointIdsList = MakeCSharpIntList(item1)
5693			jointIdsEnumerable = IEnumerable(jointIdsList)
5694			return CollectionModificationStatus[self._Entity.RemoveJoints(jointIdsEnumerable).ToString()]
5695
5696		if isinstance(item1, JointCol):
5697			return CollectionModificationStatus(super().RemoveJoints(item1))
5698
5699		return CollectionModificationStatus[self._Entity.RemoveJoints(item1).ToString()]
def RemovePanelSegments(self, item1=None) -> CollectionModificationStatus:
5701	def RemovePanelSegments(self, item1 = None) -> CollectionModificationStatus:
5702		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
5703			segmentIdsList = MakeCSharpIntList(item1)
5704			segmentIdsEnumerable = IEnumerable(segmentIdsList)
5705			return CollectionModificationStatus[self._Entity.RemovePanelSegments(segmentIdsEnumerable).ToString()]
5706
5707		if isinstance(item1, PanelSegmentCol):
5708			return CollectionModificationStatus(super().RemovePanelSegments(item1))
5709
5710		return CollectionModificationStatus[self._Entity.RemovePanelSegments(item1).ToString()]
def RemoveZones(self, item1=None) -> CollectionModificationStatus:
5712	def RemoveZones(self, item1 = None) -> CollectionModificationStatus:
5713		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
5714			zoneIdsList = MakeCSharpIntList(item1)
5715			zoneIdsEnumerable = IEnumerable(zoneIdsList)
5716			return CollectionModificationStatus[self._Entity.RemoveZones(zoneIdsEnumerable).ToString()]
5717
5718		if isinstance(item1, ZoneCol):
5719			return CollectionModificationStatus(super().RemoveZones(item1))
5720
5721		return CollectionModificationStatus[self._Entity.RemoveZones(item1).ToString()]
def RemoveJoint(self, item1=None) -> CollectionModificationStatus:
5723	def RemoveJoint(self, item1 = None) -> CollectionModificationStatus:
5724		if isinstance(item1, int):
5725			return CollectionModificationStatus(super().RemoveJoint(item1))
5726
5727		if isinstance(item1, Joint):
5728			return CollectionModificationStatus(super().RemoveJoint(item1))
5729
5730		return CollectionModificationStatus[self._Entity.RemoveJoint(item1).ToString()]
def AddZone(self, item1=None) -> CollectionModificationStatus:
5732	def AddZone(self, item1 = None) -> CollectionModificationStatus:
5733		if isinstance(item1, int):
5734			return CollectionModificationStatus(super().AddZone(item1))
5735
5736		if isinstance(item1, Zone):
5737			return CollectionModificationStatus(super().AddZone(item1))
5738
5739		return CollectionModificationStatus[self._Entity.AddZone(item1).ToString()]
def RemoveZone(self, item1=None) -> CollectionModificationStatus:
5741	def RemoveZone(self, item1 = None) -> CollectionModificationStatus:
5742		if isinstance(item1, int):
5743			return CollectionModificationStatus(super().RemoveZone(item1))
5744
5745		if isinstance(item1, Zone):
5746			return CollectionModificationStatus(super().RemoveZone(item1))
5747
5748		return CollectionModificationStatus[self._Entity.RemoveZone(item1).ToString()]
def RemovePanelSegment(self, item1=None) -> CollectionModificationStatus:
5750	def RemovePanelSegment(self, item1 = None) -> CollectionModificationStatus:
5751		if isinstance(item1, int):
5752			return CollectionModificationStatus(super().RemovePanelSegment(item1))
5753
5754		if isinstance(item1, PanelSegment):
5755			return CollectionModificationStatus(super().RemovePanelSegment(item1))
5756
5757		return CollectionModificationStatus[self._Entity.RemovePanelSegment(item1).ToString()]
class PlyCol(hyperx.api.IdNameEntityCol[hyperx.api.Ply]):
5760class PlyCol(IdNameEntityCol[Ply]):
5761	def __init__(self, plyCol: _api.PlyCol):
5762		self._Entity = plyCol
5763		self._CollectedClass = Ply
5764
5765	@property
5766	def PlyColList(self) -> tuple[Ply]:
5767		return tuple([Ply(plyCol) for plyCol in self._Entity])
5768
5769	def Delete(self, id: int) -> CollectionModificationStatus:
5770		return CollectionModificationStatus[self._Entity.Delete(id).ToString()]
5771
5772	def DeleteAll(self) -> None:
5773		'''
5774		Delete all plies in the collection.
5775		'''
5776		return self._Entity.DeleteAll()
5777
5778	def ExportToCSV(self, filepath: str) -> None:
5779		return self._Entity.ExportToCSV(filepath)
5780
5781	def ImportCSV(self, filepath: str) -> None:
5782		return self._Entity.ImportCSV(filepath)
5783
5784	@overload
5785	def Get(self, name: str) -> Ply: ...
5786
5787	@overload
5788	def Get(self, id: int) -> Ply: ...
5789
5790	def Get(self, item1 = None) -> Ply:
5791		if isinstance(item1, str):
5792			return Ply(super().Get(item1))
5793
5794		if isinstance(item1, int):
5795			return Ply(super().Get(item1))
5796
5797		return Ply(self._Entity.Get(item1))
5798
5799	def __getitem__(self, index: int):
5800		return self.PlyColList[index]
5801
5802	def __iter__(self):
5803		yield from self.PlyColList
5804
5805	def __len__(self):
5806		return len(self.PlyColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

PlyCol(plyCol: HyperX.Scripting.PlyCol)
5761	def __init__(self, plyCol: _api.PlyCol):
5762		self._Entity = plyCol
5763		self._CollectedClass = Ply
PlyColList: tuple[Ply]
5765	@property
5766	def PlyColList(self) -> tuple[Ply]:
5767		return tuple([Ply(plyCol) for plyCol in self._Entity])
def Delete(self, id: int) -> CollectionModificationStatus:
5769	def Delete(self, id: int) -> CollectionModificationStatus:
5770		return CollectionModificationStatus[self._Entity.Delete(id).ToString()]
def DeleteAll(self) -> None:
5772	def DeleteAll(self) -> None:
5773		'''
5774		Delete all plies in the collection.
5775		'''
5776		return self._Entity.DeleteAll()

Delete all plies in the collection.

def ExportToCSV(self, filepath: str) -> None:
5778	def ExportToCSV(self, filepath: str) -> None:
5779		return self._Entity.ExportToCSV(filepath)
def ImportCSV(self, filepath: str) -> None:
5781	def ImportCSV(self, filepath: str) -> None:
5782		return self._Entity.ImportCSV(filepath)
def Get(self, item1=None) -> Ply:
5790	def Get(self, item1 = None) -> Ply:
5791		if isinstance(item1, str):
5792			return Ply(super().Get(item1))
5793
5794		if isinstance(item1, int):
5795			return Ply(super().Get(item1))
5796
5797		return Ply(self._Entity.Get(item1))
class Structure(ZoneJointContainer):
5809class Structure(ZoneJointContainer):
5810	def __init__(self, structure: _api.Structure):
5811		self._Entity = structure
5812
5813	@property
5814	def Plies(self) -> PlyCol:
5815		result = self._Entity.Plies
5816		return PlyCol(result) if result is not None else None
5817
5818	@property
5819	def Joints(self) -> JointCol:
5820		result = self._Entity.Joints
5821		return JointCol(result) if result is not None else None
5822
5823	@property
5824	def PanelSegments(self) -> PanelSegmentCol:
5825		result = self._Entity.PanelSegments
5826		return PanelSegmentCol(result) if result is not None else None
5827
5828	@property
5829	def Zones(self) -> ZoneCol:
5830		result = self._Entity.Zones
5831		return ZoneCol(result) if result is not None else None
5832
5833	def ExportVCP(self, fileName: str) -> None:
5834		return self._Entity.ExportVCP(fileName)
5835
5836	def AddElements(self, elementIds: tuple[int]) -> CollectionModificationStatus:
5837		elementIdsList = MakeCSharpIntList(elementIds)
5838		elementIdsEnumerable = IEnumerable(elementIdsList)
5839		return CollectionModificationStatus[self._Entity.AddElements(elementIdsEnumerable).ToString()]
5840
5841	@overload
5842	def AddJoint(self, joint: Joint) -> CollectionModificationStatus: ...
5843
5844	@overload
5845	def AddPanelSegment(self, segment: PanelSegment) -> CollectionModificationStatus: ...
5846
5847	def AddPfemProperties(self, pfemPropertyIds: tuple[int]) -> CollectionModificationStatus:
5848		pfemPropertyIdsList = MakeCSharpIntList(pfemPropertyIds)
5849		pfemPropertyIdsEnumerable = IEnumerable(pfemPropertyIdsList)
5850		return CollectionModificationStatus[self._Entity.AddPfemProperties(pfemPropertyIdsEnumerable).ToString()]
5851
5852	@overload
5853	def AddZones(self, zones: tuple[Zone]) -> CollectionModificationStatus: ...
5854
5855	def CreateZone(self, elementIds: tuple[int], name: str = None) -> Zone:
5856		elementIdsList = MakeCSharpIntList(elementIds)
5857		elementIdsEnumerable = IEnumerable(elementIdsList)
5858		result = self._Entity.CreateZone(elementIdsEnumerable, name)
5859		thisClass = type(result).__name__
5860		givenClass = Zone
5861		for subclass in Zone.__subclasses__():
5862			if subclass.__name__ == thisClass:
5863				givenClass = subclass
5864		return givenClass(result)
5865
5866	def CreatePanelSegment(self, discreteTechnique: types.DiscreteTechnique, discreteElementLkp: dict[types.DiscreteDefinitionType, list[int]], name: str = None) -> PanelSegment:
5867		discreteElementLkpDict = Dictionary[_types.DiscreteDefinitionType, List[int]]()
5868		for kvp in discreteElementLkp:
5869			discreteElementLkpDict.Add(_types.DiscreteDefinitionType(kvp.value), MakeCSharpIntList(discreteElementLkp[kvp]))
5870		return PanelSegment(self._Entity.CreatePanelSegment(_types.DiscreteTechnique(discreteTechnique.value), discreteElementLkpDict, name))
5871
5872	@overload
5873	def Remove(self, zoneIds: tuple[int], jointIds: tuple[int]) -> CollectionModificationStatus: ...
5874
5875	@overload
5876	def Remove(self, zoneIds: tuple[int], jointIds: tuple[int], panelSegmentIds: tuple[int]) -> CollectionModificationStatus: ...
5877
5878	@overload
5879	def RemoveJoints(self, jointIds: tuple[int]) -> CollectionModificationStatus: ...
5880
5881	@overload
5882	def RemovePanelSegments(self, segmentIds: tuple[int]) -> CollectionModificationStatus: ...
5883
5884	@overload
5885	def RemoveZones(self, zoneIds: tuple[int]) -> CollectionModificationStatus: ...
5886
5887	@overload
5888	def AddJoint(self, id: int) -> CollectionModificationStatus: ...
5889
5890	@overload
5891	def RemoveJoint(self, id: int) -> CollectionModificationStatus: ...
5892
5893	@overload
5894	def RemoveJoint(self, joint: Joint) -> CollectionModificationStatus: ...
5895
5896	@overload
5897	def RemoveJoints(self, joints: JointCol) -> CollectionModificationStatus: ...
5898
5899	@overload
5900	def AddZone(self, id: int) -> CollectionModificationStatus: ...
5901
5902	@overload
5903	def AddZones(self, ids: tuple[int]) -> CollectionModificationStatus: ...
5904
5905	@overload
5906	def AddZone(self, zone: Zone) -> CollectionModificationStatus: ...
5907
5908	@overload
5909	def RemoveZone(self, id: int) -> CollectionModificationStatus: ...
5910
5911	@overload
5912	def RemoveZone(self, zone: Zone) -> CollectionModificationStatus: ...
5913
5914	@overload
5915	def RemoveZones(self, zones: ZoneCol) -> CollectionModificationStatus: ...
5916
5917	@overload
5918	def AddPanelSegment(self, id: int) -> CollectionModificationStatus: ...
5919
5920	@overload
5921	def RemovePanelSegment(self, id: int) -> CollectionModificationStatus: ...
5922
5923	@overload
5924	def RemovePanelSegment(self, segment: PanelSegment) -> CollectionModificationStatus: ...
5925
5926	@overload
5927	def RemovePanelSegments(self, segments: PanelSegmentCol) -> CollectionModificationStatus: ...
5928
5929	def AddJoint(self, item1 = None) -> CollectionModificationStatus:
5930		if isinstance(item1, Joint):
5931			return CollectionModificationStatus[self._Entity.AddJoint(item1._Entity).ToString()]
5932
5933		if isinstance(item1, int):
5934			return CollectionModificationStatus(super().AddJoint(item1))
5935
5936		return CollectionModificationStatus[self._Entity.AddJoint(item1._Entity).ToString()]
5937
5938	def AddPanelSegment(self, item1 = None) -> CollectionModificationStatus:
5939		if isinstance(item1, PanelSegment):
5940			return CollectionModificationStatus[self._Entity.AddPanelSegment(item1._Entity).ToString()]
5941
5942		if isinstance(item1, int):
5943			return CollectionModificationStatus(super().AddPanelSegment(item1))
5944
5945		return CollectionModificationStatus[self._Entity.AddPanelSegment(item1._Entity).ToString()]
5946
5947	def AddZones(self, item1 = None) -> CollectionModificationStatus:
5948		if isinstance(item1, tuple) and item1 and isinstance(item1[0], Zone):
5949			zonesList = List[_api.Zone]()
5950			if item1 is not None:
5951				for thing in item1:
5952					if thing is not None:
5953						zonesList.Add(thing._Entity)
5954			zonesEnumerable = IEnumerable(zonesList)
5955			return CollectionModificationStatus[self._Entity.AddZones(zonesEnumerable).ToString()]
5956
5957		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
5958			return CollectionModificationStatus(super().AddZones(item1))
5959
5960		return CollectionModificationStatus[self._Entity.AddZones(item1).ToString()]
5961
5962	def Remove(self, item1 = None, item2 = None, item3 = None) -> CollectionModificationStatus:
5963		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int) and isinstance(item2, tuple) and item2 and isinstance(item2[0], int) and isinstance(item3, tuple) and item3 and isinstance(item3[0], int):
5964			zoneIdsList = MakeCSharpIntList(item1)
5965			zoneIdsEnumerable = IEnumerable(zoneIdsList)
5966			jointIdsList = MakeCSharpIntList(item2)
5967			jointIdsEnumerable = IEnumerable(jointIdsList)
5968			panelSegmentIdsList = MakeCSharpIntList(item3)
5969			panelSegmentIdsEnumerable = IEnumerable(panelSegmentIdsList)
5970			return CollectionModificationStatus[self._Entity.Remove(zoneIdsEnumerable, jointIdsEnumerable, panelSegmentIdsEnumerable).ToString()]
5971
5972		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int) and isinstance(item2, tuple) and item2 and isinstance(item2[0], int):
5973			zoneIdsList = MakeCSharpIntList(item1)
5974			zoneIdsEnumerable = IEnumerable(zoneIdsList)
5975			jointIdsList = MakeCSharpIntList(item2)
5976			jointIdsEnumerable = IEnumerable(jointIdsList)
5977			return CollectionModificationStatus[self._Entity.Remove(zoneIdsEnumerable, jointIdsEnumerable).ToString()]
5978
5979		return CollectionModificationStatus[self._Entity.Remove(item1, item2, item3).ToString()]
5980
5981	def RemoveJoints(self, item1 = None) -> CollectionModificationStatus:
5982		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
5983			jointIdsList = MakeCSharpIntList(item1)
5984			jointIdsEnumerable = IEnumerable(jointIdsList)
5985			return CollectionModificationStatus[self._Entity.RemoveJoints(jointIdsEnumerable).ToString()]
5986
5987		if isinstance(item1, JointCol):
5988			return CollectionModificationStatus(super().RemoveJoints(item1))
5989
5990		return CollectionModificationStatus[self._Entity.RemoveJoints(item1).ToString()]
5991
5992	def RemovePanelSegments(self, item1 = None) -> CollectionModificationStatus:
5993		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
5994			segmentIdsList = MakeCSharpIntList(item1)
5995			segmentIdsEnumerable = IEnumerable(segmentIdsList)
5996			return CollectionModificationStatus[self._Entity.RemovePanelSegments(segmentIdsEnumerable).ToString()]
5997
5998		if isinstance(item1, PanelSegmentCol):
5999			return CollectionModificationStatus(super().RemovePanelSegments(item1))
6000
6001		return CollectionModificationStatus[self._Entity.RemovePanelSegments(item1).ToString()]
6002
6003	def RemoveZones(self, item1 = None) -> CollectionModificationStatus:
6004		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
6005			zoneIdsList = MakeCSharpIntList(item1)
6006			zoneIdsEnumerable = IEnumerable(zoneIdsList)
6007			return CollectionModificationStatus[self._Entity.RemoveZones(zoneIdsEnumerable).ToString()]
6008
6009		if isinstance(item1, ZoneCol):
6010			return CollectionModificationStatus(super().RemoveZones(item1))
6011
6012		return CollectionModificationStatus[self._Entity.RemoveZones(item1).ToString()]
6013
6014	def RemoveJoint(self, item1 = None) -> CollectionModificationStatus:
6015		if isinstance(item1, int):
6016			return CollectionModificationStatus(super().RemoveJoint(item1))
6017
6018		if isinstance(item1, Joint):
6019			return CollectionModificationStatus(super().RemoveJoint(item1))
6020
6021		return CollectionModificationStatus[self._Entity.RemoveJoint(item1).ToString()]
6022
6023	def AddZone(self, item1 = None) -> CollectionModificationStatus:
6024		if isinstance(item1, int):
6025			return CollectionModificationStatus(super().AddZone(item1))
6026
6027		if isinstance(item1, Zone):
6028			return CollectionModificationStatus(super().AddZone(item1))
6029
6030		return CollectionModificationStatus[self._Entity.AddZone(item1).ToString()]
6031
6032	def RemoveZone(self, item1 = None) -> CollectionModificationStatus:
6033		if isinstance(item1, int):
6034			return CollectionModificationStatus(super().RemoveZone(item1))
6035
6036		if isinstance(item1, Zone):
6037			return CollectionModificationStatus(super().RemoveZone(item1))
6038
6039		return CollectionModificationStatus[self._Entity.RemoveZone(item1).ToString()]
6040
6041	def RemovePanelSegment(self, item1 = None) -> CollectionModificationStatus:
6042		if isinstance(item1, int):
6043			return CollectionModificationStatus(super().RemovePanelSegment(item1))
6044
6045		if isinstance(item1, PanelSegment):
6046			return CollectionModificationStatus(super().RemovePanelSegment(item1))
6047
6048		return CollectionModificationStatus[self._Entity.RemovePanelSegment(item1).ToString()]

Represents an entity that contains a collection of Zones and Joints.

Structure(structure: HyperX.Scripting.Structure)
5810	def __init__(self, structure: _api.Structure):
5811		self._Entity = structure
Plies: PlyCol
5813	@property
5814	def Plies(self) -> PlyCol:
5815		result = self._Entity.Plies
5816		return PlyCol(result) if result is not None else None
Joints: JointCol
5818	@property
5819	def Joints(self) -> JointCol:
5820		result = self._Entity.Joints
5821		return JointCol(result) if result is not None else None
PanelSegments: PanelSegmentCol
5823	@property
5824	def PanelSegments(self) -> PanelSegmentCol:
5825		result = self._Entity.PanelSegments
5826		return PanelSegmentCol(result) if result is not None else None
Zones: ZoneCol
5828	@property
5829	def Zones(self) -> ZoneCol:
5830		result = self._Entity.Zones
5831		return ZoneCol(result) if result is not None else None
def ExportVCP(self, fileName: str) -> None:
5833	def ExportVCP(self, fileName: str) -> None:
5834		return self._Entity.ExportVCP(fileName)
def AddElements(self, elementIds: tuple[int]) -> CollectionModificationStatus:
5836	def AddElements(self, elementIds: tuple[int]) -> CollectionModificationStatus:
5837		elementIdsList = MakeCSharpIntList(elementIds)
5838		elementIdsEnumerable = IEnumerable(elementIdsList)
5839		return CollectionModificationStatus[self._Entity.AddElements(elementIdsEnumerable).ToString()]
def AddJoint(self, item1=None) -> CollectionModificationStatus:
5929	def AddJoint(self, item1 = None) -> CollectionModificationStatus:
5930		if isinstance(item1, Joint):
5931			return CollectionModificationStatus[self._Entity.AddJoint(item1._Entity).ToString()]
5932
5933		if isinstance(item1, int):
5934			return CollectionModificationStatus(super().AddJoint(item1))
5935
5936		return CollectionModificationStatus[self._Entity.AddJoint(item1._Entity).ToString()]
def AddPanelSegment(self, item1=None) -> CollectionModificationStatus:
5938	def AddPanelSegment(self, item1 = None) -> CollectionModificationStatus:
5939		if isinstance(item1, PanelSegment):
5940			return CollectionModificationStatus[self._Entity.AddPanelSegment(item1._Entity).ToString()]
5941
5942		if isinstance(item1, int):
5943			return CollectionModificationStatus(super().AddPanelSegment(item1))
5944
5945		return CollectionModificationStatus[self._Entity.AddPanelSegment(item1._Entity).ToString()]
def AddPfemProperties( self, pfemPropertyIds: tuple[int]) -> CollectionModificationStatus:
5847	def AddPfemProperties(self, pfemPropertyIds: tuple[int]) -> CollectionModificationStatus:
5848		pfemPropertyIdsList = MakeCSharpIntList(pfemPropertyIds)
5849		pfemPropertyIdsEnumerable = IEnumerable(pfemPropertyIdsList)
5850		return CollectionModificationStatus[self._Entity.AddPfemProperties(pfemPropertyIdsEnumerable).ToString()]
def AddZones(self, item1=None) -> CollectionModificationStatus:
5947	def AddZones(self, item1 = None) -> CollectionModificationStatus:
5948		if isinstance(item1, tuple) and item1 and isinstance(item1[0], Zone):
5949			zonesList = List[_api.Zone]()
5950			if item1 is not None:
5951				for thing in item1:
5952					if thing is not None:
5953						zonesList.Add(thing._Entity)
5954			zonesEnumerable = IEnumerable(zonesList)
5955			return CollectionModificationStatus[self._Entity.AddZones(zonesEnumerable).ToString()]
5956
5957		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
5958			return CollectionModificationStatus(super().AddZones(item1))
5959
5960		return CollectionModificationStatus[self._Entity.AddZones(item1).ToString()]
def CreateZone(self, elementIds: tuple[int], name: str = None) -> Zone:
5855	def CreateZone(self, elementIds: tuple[int], name: str = None) -> Zone:
5856		elementIdsList = MakeCSharpIntList(elementIds)
5857		elementIdsEnumerable = IEnumerable(elementIdsList)
5858		result = self._Entity.CreateZone(elementIdsEnumerable, name)
5859		thisClass = type(result).__name__
5860		givenClass = Zone
5861		for subclass in Zone.__subclasses__():
5862			if subclass.__name__ == thisClass:
5863				givenClass = subclass
5864		return givenClass(result)
def CreatePanelSegment( self, discreteTechnique: hyperx.api.types.DiscreteTechnique, discreteElementLkp: dict[hyperx.api.types.DiscreteDefinitionType, list[int]], name: str = None) -> PanelSegment:
5866	def CreatePanelSegment(self, discreteTechnique: types.DiscreteTechnique, discreteElementLkp: dict[types.DiscreteDefinitionType, list[int]], name: str = None) -> PanelSegment:
5867		discreteElementLkpDict = Dictionary[_types.DiscreteDefinitionType, List[int]]()
5868		for kvp in discreteElementLkp:
5869			discreteElementLkpDict.Add(_types.DiscreteDefinitionType(kvp.value), MakeCSharpIntList(discreteElementLkp[kvp]))
5870		return PanelSegment(self._Entity.CreatePanelSegment(_types.DiscreteTechnique(discreteTechnique.value), discreteElementLkpDict, name))
def Remove( self, item1=None, item2=None, item3=None) -> CollectionModificationStatus:
5962	def Remove(self, item1 = None, item2 = None, item3 = None) -> CollectionModificationStatus:
5963		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int) and isinstance(item2, tuple) and item2 and isinstance(item2[0], int) and isinstance(item3, tuple) and item3 and isinstance(item3[0], int):
5964			zoneIdsList = MakeCSharpIntList(item1)
5965			zoneIdsEnumerable = IEnumerable(zoneIdsList)
5966			jointIdsList = MakeCSharpIntList(item2)
5967			jointIdsEnumerable = IEnumerable(jointIdsList)
5968			panelSegmentIdsList = MakeCSharpIntList(item3)
5969			panelSegmentIdsEnumerable = IEnumerable(panelSegmentIdsList)
5970			return CollectionModificationStatus[self._Entity.Remove(zoneIdsEnumerable, jointIdsEnumerable, panelSegmentIdsEnumerable).ToString()]
5971
5972		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int) and isinstance(item2, tuple) and item2 and isinstance(item2[0], int):
5973			zoneIdsList = MakeCSharpIntList(item1)
5974			zoneIdsEnumerable = IEnumerable(zoneIdsList)
5975			jointIdsList = MakeCSharpIntList(item2)
5976			jointIdsEnumerable = IEnumerable(jointIdsList)
5977			return CollectionModificationStatus[self._Entity.Remove(zoneIdsEnumerable, jointIdsEnumerable).ToString()]
5978
5979		return CollectionModificationStatus[self._Entity.Remove(item1, item2, item3).ToString()]
def RemoveJoints(self, item1=None) -> CollectionModificationStatus:
5981	def RemoveJoints(self, item1 = None) -> CollectionModificationStatus:
5982		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
5983			jointIdsList = MakeCSharpIntList(item1)
5984			jointIdsEnumerable = IEnumerable(jointIdsList)
5985			return CollectionModificationStatus[self._Entity.RemoveJoints(jointIdsEnumerable).ToString()]
5986
5987		if isinstance(item1, JointCol):
5988			return CollectionModificationStatus(super().RemoveJoints(item1))
5989
5990		return CollectionModificationStatus[self._Entity.RemoveJoints(item1).ToString()]
def RemovePanelSegments(self, item1=None) -> CollectionModificationStatus:
5992	def RemovePanelSegments(self, item1 = None) -> CollectionModificationStatus:
5993		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
5994			segmentIdsList = MakeCSharpIntList(item1)
5995			segmentIdsEnumerable = IEnumerable(segmentIdsList)
5996			return CollectionModificationStatus[self._Entity.RemovePanelSegments(segmentIdsEnumerable).ToString()]
5997
5998		if isinstance(item1, PanelSegmentCol):
5999			return CollectionModificationStatus(super().RemovePanelSegments(item1))
6000
6001		return CollectionModificationStatus[self._Entity.RemovePanelSegments(item1).ToString()]
def RemoveZones(self, item1=None) -> CollectionModificationStatus:
6003	def RemoveZones(self, item1 = None) -> CollectionModificationStatus:
6004		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int):
6005			zoneIdsList = MakeCSharpIntList(item1)
6006			zoneIdsEnumerable = IEnumerable(zoneIdsList)
6007			return CollectionModificationStatus[self._Entity.RemoveZones(zoneIdsEnumerable).ToString()]
6008
6009		if isinstance(item1, ZoneCol):
6010			return CollectionModificationStatus(super().RemoveZones(item1))
6011
6012		return CollectionModificationStatus[self._Entity.RemoveZones(item1).ToString()]
def RemoveJoint(self, item1=None) -> CollectionModificationStatus:
6014	def RemoveJoint(self, item1 = None) -> CollectionModificationStatus:
6015		if isinstance(item1, int):
6016			return CollectionModificationStatus(super().RemoveJoint(item1))
6017
6018		if isinstance(item1, Joint):
6019			return CollectionModificationStatus(super().RemoveJoint(item1))
6020
6021		return CollectionModificationStatus[self._Entity.RemoveJoint(item1).ToString()]
def AddZone(self, item1=None) -> CollectionModificationStatus:
6023	def AddZone(self, item1 = None) -> CollectionModificationStatus:
6024		if isinstance(item1, int):
6025			return CollectionModificationStatus(super().AddZone(item1))
6026
6027		if isinstance(item1, Zone):
6028			return CollectionModificationStatus(super().AddZone(item1))
6029
6030		return CollectionModificationStatus[self._Entity.AddZone(item1).ToString()]
def RemoveZone(self, item1=None) -> CollectionModificationStatus:
6032	def RemoveZone(self, item1 = None) -> CollectionModificationStatus:
6033		if isinstance(item1, int):
6034			return CollectionModificationStatus(super().RemoveZone(item1))
6035
6036		if isinstance(item1, Zone):
6037			return CollectionModificationStatus(super().RemoveZone(item1))
6038
6039		return CollectionModificationStatus[self._Entity.RemoveZone(item1).ToString()]
def RemovePanelSegment(self, item1=None) -> CollectionModificationStatus:
6041	def RemovePanelSegment(self, item1 = None) -> CollectionModificationStatus:
6042		if isinstance(item1, int):
6043			return CollectionModificationStatus(super().RemovePanelSegment(item1))
6044
6045		if isinstance(item1, PanelSegment):
6046			return CollectionModificationStatus(super().RemovePanelSegment(item1))
6047
6048		return CollectionModificationStatus[self._Entity.RemovePanelSegment(item1).ToString()]
class AnalysisPropertyCol(hyperx.api.IdNameEntityCol[hyperx.api.AnalysisProperty]):
6051class AnalysisPropertyCol(IdNameEntityCol[AnalysisProperty]):
6052	def __init__(self, analysisPropertyCol: _api.AnalysisPropertyCol):
6053		self._Entity = analysisPropertyCol
6054		self._CollectedClass = AnalysisProperty
6055
6056	@property
6057	def AnalysisPropertyColList(self) -> tuple[AnalysisProperty]:
6058		return tuple([AnalysisProperty(analysisPropertyCol) for analysisPropertyCol in self._Entity])
6059
6060	def CreateAnalysisProperty(self, type: types.FamilyCategory, name: str = None) -> AnalysisProperty:
6061		return AnalysisProperty(self._Entity.CreateAnalysisProperty(_types.FamilyCategory(type.value), name))
6062
6063	@overload
6064	def DeleteAnalysisProperty(self, name: str) -> bool: ...
6065
6066	@overload
6067	def DeleteAnalysisProperty(self, id: int) -> bool: ...
6068
6069	@overload
6070	def Get(self, name: str) -> AnalysisProperty: ...
6071
6072	@overload
6073	def Get(self, id: int) -> AnalysisProperty: ...
6074
6075	def DeleteAnalysisProperty(self, item1 = None) -> bool:
6076		if isinstance(item1, str):
6077			return self._Entity.DeleteAnalysisProperty(item1)
6078
6079		if isinstance(item1, int):
6080			return self._Entity.DeleteAnalysisProperty(item1)
6081
6082		return self._Entity.DeleteAnalysisProperty(item1)
6083
6084	def Get(self, item1 = None) -> AnalysisProperty:
6085		if isinstance(item1, str):
6086			return AnalysisProperty(super().Get(item1))
6087
6088		if isinstance(item1, int):
6089			return AnalysisProperty(super().Get(item1))
6090
6091		return AnalysisProperty(self._Entity.Get(item1))
6092
6093	def __getitem__(self, index: int):
6094		return self.AnalysisPropertyColList[index]
6095
6096	def __iter__(self):
6097		yield from self.AnalysisPropertyColList
6098
6099	def __len__(self):
6100		return len(self.AnalysisPropertyColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

AnalysisPropertyCol(analysisPropertyCol: HyperX.Scripting.AnalysisPropertyCol)
6052	def __init__(self, analysisPropertyCol: _api.AnalysisPropertyCol):
6053		self._Entity = analysisPropertyCol
6054		self._CollectedClass = AnalysisProperty
AnalysisPropertyColList: tuple[AnalysisProperty]
6056	@property
6057	def AnalysisPropertyColList(self) -> tuple[AnalysisProperty]:
6058		return tuple([AnalysisProperty(analysisPropertyCol) for analysisPropertyCol in self._Entity])
def CreateAnalysisProperty( self, type: hyperx.api.types.FamilyCategory, name: str = None) -> AnalysisProperty:
6060	def CreateAnalysisProperty(self, type: types.FamilyCategory, name: str = None) -> AnalysisProperty:
6061		return AnalysisProperty(self._Entity.CreateAnalysisProperty(_types.FamilyCategory(type.value), name))
def DeleteAnalysisProperty(self, item1=None) -> bool:
6075	def DeleteAnalysisProperty(self, item1 = None) -> bool:
6076		if isinstance(item1, str):
6077			return self._Entity.DeleteAnalysisProperty(item1)
6078
6079		if isinstance(item1, int):
6080			return self._Entity.DeleteAnalysisProperty(item1)
6081
6082		return self._Entity.DeleteAnalysisProperty(item1)
def Get(self, item1=None) -> AnalysisProperty:
6084	def Get(self, item1 = None) -> AnalysisProperty:
6085		if isinstance(item1, str):
6086			return AnalysisProperty(super().Get(item1))
6087
6088		if isinstance(item1, int):
6089			return AnalysisProperty(super().Get(item1))
6090
6091		return AnalysisProperty(self._Entity.Get(item1))
class DesignPropertyCol(hyperx.api.IdNameEntityCol[hyperx.api.DesignProperty]):
6103class DesignPropertyCol(IdNameEntityCol[DesignProperty]):
6104	def __init__(self, designPropertyCol: _api.DesignPropertyCol):
6105		self._Entity = designPropertyCol
6106		self._CollectedClass = DesignProperty
6107
6108	@property
6109	def DesignPropertyColList(self) -> tuple[DesignProperty]:
6110		return tuple([DesignProperty(designPropertyCol) for designPropertyCol in self._Entity])
6111
6112	def CreateDesignProperty(self, familyConcept: types.FamilyConceptUID, materialMode: types.MaterialMode = types.MaterialMode.Any, name: str = None) -> DesignProperty:
6113		result = self._Entity.CreateDesignProperty(_types.FamilyConceptUID(familyConcept.value), _types.MaterialMode(materialMode.value), name)
6114		thisClass = type(result).__name__
6115		givenClass = DesignProperty
6116		for subclass in DesignProperty.__subclasses__():
6117			if subclass.__name__ == thisClass:
6118				givenClass = subclass
6119		return givenClass(result)
6120
6121	@overload
6122	def Get(self, name: str) -> DesignProperty: ...
6123
6124	@overload
6125	def Get(self, id: int) -> DesignProperty: ...
6126
6127	def Get(self, item1 = None) -> DesignProperty:
6128		if isinstance(item1, str):
6129			return DesignProperty(super().Get(item1))
6130
6131		if isinstance(item1, int):
6132			return DesignProperty(super().Get(item1))
6133
6134		result = self._Entity.Get(item1)
6135		thisClass = type(result).__name__
6136		givenClass = DesignProperty
6137		for subclass in DesignProperty.__subclasses__():
6138			if subclass.__name__ == thisClass:
6139				givenClass = subclass
6140		return givenClass(result)
6141
6142	def __getitem__(self, index: int):
6143		return self.DesignPropertyColList[index]
6144
6145	def __iter__(self):
6146		yield from self.DesignPropertyColList
6147
6148	def __len__(self):
6149		return len(self.DesignPropertyColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

DesignPropertyCol(designPropertyCol: HyperX.Scripting.DesignPropertyCol)
6104	def __init__(self, designPropertyCol: _api.DesignPropertyCol):
6105		self._Entity = designPropertyCol
6106		self._CollectedClass = DesignProperty
DesignPropertyColList: tuple[DesignProperty]
6108	@property
6109	def DesignPropertyColList(self) -> tuple[DesignProperty]:
6110		return tuple([DesignProperty(designPropertyCol) for designPropertyCol in self._Entity])
def CreateDesignProperty( self, familyConcept: hyperx.api.types.FamilyConceptUID, materialMode: hyperx.api.types.MaterialMode = <MaterialMode.Any: 3>, name: str = None) -> DesignProperty:
6112	def CreateDesignProperty(self, familyConcept: types.FamilyConceptUID, materialMode: types.MaterialMode = types.MaterialMode.Any, name: str = None) -> DesignProperty:
6113		result = self._Entity.CreateDesignProperty(_types.FamilyConceptUID(familyConcept.value), _types.MaterialMode(materialMode.value), name)
6114		thisClass = type(result).__name__
6115		givenClass = DesignProperty
6116		for subclass in DesignProperty.__subclasses__():
6117			if subclass.__name__ == thisClass:
6118				givenClass = subclass
6119		return givenClass(result)
def Get(self, item1=None) -> DesignProperty:
6127	def Get(self, item1 = None) -> DesignProperty:
6128		if isinstance(item1, str):
6129			return DesignProperty(super().Get(item1))
6130
6131		if isinstance(item1, int):
6132			return DesignProperty(super().Get(item1))
6133
6134		result = self._Entity.Get(item1)
6135		thisClass = type(result).__name__
6136		givenClass = DesignProperty
6137		for subclass in DesignProperty.__subclasses__():
6138			if subclass.__name__ == thisClass:
6139				givenClass = subclass
6140		return givenClass(result)
class LoadPropertyCol(hyperx.api.IdNameEntityCol[hyperx.api.LoadProperty]):
6152class LoadPropertyCol(IdNameEntityCol[LoadProperty]):
6153	def __init__(self, loadPropertyCol: _api.LoadPropertyCol):
6154		self._Entity = loadPropertyCol
6155		self._CollectedClass = LoadProperty
6156
6157	@property
6158	def LoadPropertyColList(self) -> tuple[LoadProperty]:
6159		return tuple([LoadProperty(loadPropertyCol) for loadPropertyCol in self._Entity])
6160
6161	def CreateLoadProperty(self, loadPropertyType: types.LoadPropertyType, category: types.FamilyCategory, name: str = None) -> LoadProperty:
6162		result = self._Entity.CreateLoadProperty(_types.LoadPropertyType(loadPropertyType.value), _types.FamilyCategory(category.value), name)
6163		thisClass = type(result).__name__
6164		givenClass = LoadProperty
6165		for subclass in LoadProperty.__subclasses__():
6166			if subclass.__name__ == thisClass:
6167				givenClass = subclass
6168		return givenClass(result)
6169
6170	@overload
6171	def DeleteLoadProperty(self, id: int) -> bool: ...
6172
6173	@overload
6174	def DeleteLoadProperty(self, name: str) -> bool: ...
6175
6176	@overload
6177	def Get(self, name: str) -> LoadProperty: ...
6178
6179	@overload
6180	def Get(self, id: int) -> LoadProperty: ...
6181
6182	def DeleteLoadProperty(self, item1 = None) -> bool:
6183		if isinstance(item1, int):
6184			return self._Entity.DeleteLoadProperty(item1)
6185
6186		if isinstance(item1, str):
6187			return self._Entity.DeleteLoadProperty(item1)
6188
6189		return self._Entity.DeleteLoadProperty(item1)
6190
6191	def Get(self, item1 = None) -> LoadProperty:
6192		if isinstance(item1, str):
6193			return LoadProperty(super().Get(item1))
6194
6195		if isinstance(item1, int):
6196			return LoadProperty(super().Get(item1))
6197
6198		result = self._Entity.Get(item1)
6199		thisClass = type(result).__name__
6200		givenClass = LoadProperty
6201		for subclass in LoadProperty.__subclasses__():
6202			if subclass.__name__ == thisClass:
6203				givenClass = subclass
6204		return givenClass(result)
6205
6206	def __getitem__(self, index: int):
6207		return self.LoadPropertyColList[index]
6208
6209	def __iter__(self):
6210		yield from self.LoadPropertyColList
6211
6212	def __len__(self):
6213		return len(self.LoadPropertyColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

LoadPropertyCol(loadPropertyCol: HyperX.Scripting.LoadPropertyCol)
6153	def __init__(self, loadPropertyCol: _api.LoadPropertyCol):
6154		self._Entity = loadPropertyCol
6155		self._CollectedClass = LoadProperty
LoadPropertyColList: tuple[LoadProperty]
6157	@property
6158	def LoadPropertyColList(self) -> tuple[LoadProperty]:
6159		return tuple([LoadProperty(loadPropertyCol) for loadPropertyCol in self._Entity])
def CreateLoadProperty( self, loadPropertyType: hyperx.api.types.LoadPropertyType, category: hyperx.api.types.FamilyCategory, name: str = None) -> LoadProperty:
6161	def CreateLoadProperty(self, loadPropertyType: types.LoadPropertyType, category: types.FamilyCategory, name: str = None) -> LoadProperty:
6162		result = self._Entity.CreateLoadProperty(_types.LoadPropertyType(loadPropertyType.value), _types.FamilyCategory(category.value), name)
6163		thisClass = type(result).__name__
6164		givenClass = LoadProperty
6165		for subclass in LoadProperty.__subclasses__():
6166			if subclass.__name__ == thisClass:
6167				givenClass = subclass
6168		return givenClass(result)
def DeleteLoadProperty(self, item1=None) -> bool:
6182	def DeleteLoadProperty(self, item1 = None) -> bool:
6183		if isinstance(item1, int):
6184			return self._Entity.DeleteLoadProperty(item1)
6185
6186		if isinstance(item1, str):
6187			return self._Entity.DeleteLoadProperty(item1)
6188
6189		return self._Entity.DeleteLoadProperty(item1)
def Get(self, item1=None) -> LoadProperty:
6191	def Get(self, item1 = None) -> LoadProperty:
6192		if isinstance(item1, str):
6193			return LoadProperty(super().Get(item1))
6194
6195		if isinstance(item1, int):
6196			return LoadProperty(super().Get(item1))
6197
6198		result = self._Entity.Get(item1)
6199		thisClass = type(result).__name__
6200		givenClass = LoadProperty
6201		for subclass in LoadProperty.__subclasses__():
6202			if subclass.__name__ == thisClass:
6203				givenClass = subclass
6204		return givenClass(result)
class DesignLoadCol(hyperx.api.IdNameEntityCol[hyperx.api.DesignLoad]):
6216class DesignLoadCol(IdNameEntityCol[DesignLoad]):
6217	def __init__(self, designLoadCol: _api.DesignLoadCol):
6218		self._Entity = designLoadCol
6219		self._CollectedClass = DesignLoad
6220
6221	@property
6222	def DesignLoadColList(self) -> tuple[DesignLoad]:
6223		return tuple([DesignLoad(designLoadCol) for designLoadCol in self._Entity])
6224
6225	@overload
6226	def Get(self, name: str) -> DesignLoad: ...
6227
6228	@overload
6229	def Get(self, id: int) -> DesignLoad: ...
6230
6231	def Get(self, item1 = None) -> DesignLoad:
6232		if isinstance(item1, str):
6233			return DesignLoad(super().Get(item1))
6234
6235		if isinstance(item1, int):
6236			return DesignLoad(super().Get(item1))
6237
6238		return DesignLoad(self._Entity.Get(item1))
6239
6240	def __getitem__(self, index: int):
6241		return self.DesignLoadColList[index]
6242
6243	def __iter__(self):
6244		yield from self.DesignLoadColList
6245
6246	def __len__(self):
6247		return len(self.DesignLoadColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

DesignLoadCol(designLoadCol: HyperX.Scripting.DesignLoadCol)
6217	def __init__(self, designLoadCol: _api.DesignLoadCol):
6218		self._Entity = designLoadCol
6219		self._CollectedClass = DesignLoad
DesignLoadColList: tuple[DesignLoad]
6221	@property
6222	def DesignLoadColList(self) -> tuple[DesignLoad]:
6223		return tuple([DesignLoad(designLoadCol) for designLoadCol in self._Entity])
def Get(self, item1=None) -> DesignLoad:
6231	def Get(self, item1 = None) -> DesignLoad:
6232		if isinstance(item1, str):
6233			return DesignLoad(super().Get(item1))
6234
6235		if isinstance(item1, int):
6236			return DesignLoad(super().Get(item1))
6237
6238		return DesignLoad(self._Entity.Get(item1))
class DiscreteFieldCol(hyperx.api.IdNameEntityCol[hyperx.api.DiscreteField]):
6250class DiscreteFieldCol(IdNameEntityCol[DiscreteField]):
6251	def __init__(self, discreteFieldCol: _api.DiscreteFieldCol):
6252		self._Entity = discreteFieldCol
6253		self._CollectedClass = DiscreteField
6254
6255	@property
6256	def DiscreteFieldColList(self) -> tuple[DiscreteField]:
6257		return tuple([DiscreteField(discreteFieldCol) for discreteFieldCol in self._Entity])
6258
6259	def Create(self, entityType: types.DiscreteFieldPhysicalEntityType, dataType: types.DiscreteFieldDataType, name: str = None) -> DiscreteField:
6260		return DiscreteField(self._Entity.Create(_types.DiscreteFieldPhysicalEntityType(entityType.value), _types.DiscreteFieldDataType(dataType.value), name))
6261
6262	def CreateFromVCP(self, filepath: str) -> list[DiscreteField]:
6263		return [DiscreteField(discreteField) for discreteField in self._Entity.CreateFromVCP(filepath)]
6264
6265	def Delete(self, id: int) -> CollectionModificationStatus:
6266		return CollectionModificationStatus[self._Entity.Delete(id).ToString()]
6267
6268	def CreateByPointMapToElements(self, elementIds: list[int], discreteFieldIds: list[int], suffix: str = None, tolerance: float = None) -> list[DiscreteField]:
6269		elementIdsList = MakeCSharpIntList(elementIds)
6270		discreteFieldIdsList = MakeCSharpIntList(discreteFieldIds)
6271		return [DiscreteField(discreteField) for discreteField in self._Entity.CreateByPointMapToElements(elementIdsList, discreteFieldIdsList, suffix, tolerance)]
6272
6273	@overload
6274	def Get(self, name: str) -> DiscreteField: ...
6275
6276	@overload
6277	def Get(self, id: int) -> DiscreteField: ...
6278
6279	def Get(self, item1 = None) -> DiscreteField:
6280		if isinstance(item1, str):
6281			return DiscreteField(super().Get(item1))
6282
6283		if isinstance(item1, int):
6284			return DiscreteField(super().Get(item1))
6285
6286		return DiscreteField(self._Entity.Get(item1))
6287
6288	def __getitem__(self, index: int):
6289		return self.DiscreteFieldColList[index]
6290
6291	def __iter__(self):
6292		yield from self.DiscreteFieldColList
6293
6294	def __len__(self):
6295		return len(self.DiscreteFieldColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

DiscreteFieldCol(discreteFieldCol: HyperX.Scripting.DiscreteFieldCol)
6251	def __init__(self, discreteFieldCol: _api.DiscreteFieldCol):
6252		self._Entity = discreteFieldCol
6253		self._CollectedClass = DiscreteField
DiscreteFieldColList: tuple[DiscreteField]
6255	@property
6256	def DiscreteFieldColList(self) -> tuple[DiscreteField]:
6257		return tuple([DiscreteField(discreteFieldCol) for discreteFieldCol in self._Entity])
def Create( self, entityType: hyperx.api.types.DiscreteFieldPhysicalEntityType, dataType: hyperx.api.types.DiscreteFieldDataType, name: str = None) -> DiscreteField:
6259	def Create(self, entityType: types.DiscreteFieldPhysicalEntityType, dataType: types.DiscreteFieldDataType, name: str = None) -> DiscreteField:
6260		return DiscreteField(self._Entity.Create(_types.DiscreteFieldPhysicalEntityType(entityType.value), _types.DiscreteFieldDataType(dataType.value), name))
def CreateFromVCP(self, filepath: str) -> list[DiscreteField]:
6262	def CreateFromVCP(self, filepath: str) -> list[DiscreteField]:
6263		return [DiscreteField(discreteField) for discreteField in self._Entity.CreateFromVCP(filepath)]
def Delete(self, id: int) -> CollectionModificationStatus:
6265	def Delete(self, id: int) -> CollectionModificationStatus:
6266		return CollectionModificationStatus[self._Entity.Delete(id).ToString()]
def CreateByPointMapToElements( self, elementIds: list[int], discreteFieldIds: list[int], suffix: str = None, tolerance: float = None) -> list[DiscreteField]:
6268	def CreateByPointMapToElements(self, elementIds: list[int], discreteFieldIds: list[int], suffix: str = None, tolerance: float = None) -> list[DiscreteField]:
6269		elementIdsList = MakeCSharpIntList(elementIds)
6270		discreteFieldIdsList = MakeCSharpIntList(discreteFieldIds)
6271		return [DiscreteField(discreteField) for discreteField in self._Entity.CreateByPointMapToElements(elementIdsList, discreteFieldIdsList, suffix, tolerance)]
def Get(self, item1=None) -> DiscreteField:
6279	def Get(self, item1 = None) -> DiscreteField:
6280		if isinstance(item1, str):
6281			return DiscreteField(super().Get(item1))
6282
6283		if isinstance(item1, int):
6284			return DiscreteField(super().Get(item1))
6285
6286		return DiscreteField(self._Entity.Get(item1))
class ZoneJointContainerCol(IdNameEntityCol, typing.Generic[~T]):
6298class ZoneJointContainerCol(IdNameEntityCol, Generic[T]):
6299	def __init__(self, zoneJointContainerCol: _api.ZoneJointContainerCol):
6300		self._Entity = zoneJointContainerCol
6301		self._CollectedClass = T
6302
6303	@property
6304	def ZoneJointContainerColList(self) -> tuple[T]:
6305		if self._Entity.Count() <= 0:
6306			return ()
6307		thisClass = type(self._Entity._items[0]).__name__
6308		givenClass = T
6309		for subclass in T.__subclasses__():
6310			if subclass.__name__ == thisClass:
6311				givenClass = subclass
6312		return tuple([givenClass(zoneJointContainerCol) for zoneJointContainerCol in self._Entity])
6313
6314	@abstractmethod
6315	def Create(self, name: str) -> T:
6316		return self._Entity.Create(name)
6317
6318	@overload
6319	def Get(self, name: str) -> T: ...
6320
6321	@overload
6322	def Get(self, id: int) -> T: ...
6323
6324	def Get(self, item1 = None) -> T:
6325		if isinstance(item1, str):
6326			return super().Get(item1)
6327
6328		if isinstance(item1, int):
6329			return super().Get(item1)
6330
6331		return self._Entity.Get(item1)
6332
6333	def __getitem__(self, index: int):
6334		return self.ZoneJointContainerColList[index]
6335
6336	def __iter__(self):
6337		yield from self.ZoneJointContainerColList
6338
6339	def __len__(self):
6340		return len(self.ZoneJointContainerColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

ZoneJointContainerColList: tuple[~T]
6303	@property
6304	def ZoneJointContainerColList(self) -> tuple[T]:
6305		if self._Entity.Count() <= 0:
6306			return ()
6307		thisClass = type(self._Entity._items[0]).__name__
6308		givenClass = T
6309		for subclass in T.__subclasses__():
6310			if subclass.__name__ == thisClass:
6311				givenClass = subclass
6312		return tuple([givenClass(zoneJointContainerCol) for zoneJointContainerCol in self._Entity])
@abstractmethod
def Create(self, name: str) -> ~T:
6314	@abstractmethod
6315	def Create(self, name: str) -> T:
6316		return self._Entity.Create(name)
class RundeckCol(hyperx.api.IdEntityCol[hyperx.api.Rundeck]):
6343class RundeckCol(IdEntityCol[Rundeck]):
6344	def __init__(self, rundeckCol: _api.RundeckCol):
6345		self._Entity = rundeckCol
6346		self._CollectedClass = Rundeck
6347
6348	@property
6349	def RundeckColList(self) -> tuple[Rundeck]:
6350		return tuple([Rundeck(rundeckCol) for rundeckCol in self._Entity])
6351
6352	def AddRundeck(self, inputPath: str, resultPath: str = None) -> Rundeck:
6353		return Rundeck(self._Entity.AddRundeck(inputPath, resultPath))
6354
6355	def ReassignPrimary(self, id: int) -> RundeckUpdateStatus:
6356		return RundeckUpdateStatus[self._Entity.ReassignPrimary(id).ToString()]
6357
6358	def RemoveRundeck(self, id: int) -> RundeckRemoveStatus:
6359		return RundeckRemoveStatus[self._Entity.RemoveRundeck(id).ToString()]
6360
6361	def UpdateAllRundecks(self, newPaths: list[RundeckPathPair]) -> RundeckBulkUpdateStatus:
6362		newPathsList = List[_api.RundeckPathPair]()
6363		if newPaths is not None:
6364			for thing in newPaths:
6365				if thing is not None:
6366					newPathsList.Add(thing._Entity)
6367		return RundeckBulkUpdateStatus[self._Entity.UpdateAllRundecks(newPathsList).ToString()]
6368
6369	def GetRundeckPathSetters(self) -> list[RundeckPathPair]:
6370		'''
6371		Get RundeckPathSetters to be edited and input to UpdateAllRundecks.
6372		'''
6373		return [RundeckPathPair(rundeckPathPair) for rundeckPathPair in self._Entity.GetRundeckPathSetters()]
6374
6375	def ReplaceStringInAllPaths(self, stringToReplace: str, newString: str) -> RundeckBulkUpdateStatus:
6376		return RundeckBulkUpdateStatus[self._Entity.ReplaceStringInAllPaths(stringToReplace, newString).ToString()]
6377
6378	def __getitem__(self, index: int):
6379		return self.RundeckColList[index]
6380
6381	def __iter__(self):
6382		yield from self.RundeckColList
6383
6384	def __len__(self):
6385		return len(self.RundeckColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

RundeckCol(rundeckCol: HyperX.Scripting.RundeckCol)
6344	def __init__(self, rundeckCol: _api.RundeckCol):
6345		self._Entity = rundeckCol
6346		self._CollectedClass = Rundeck
RundeckColList: tuple[Rundeck]
6348	@property
6349	def RundeckColList(self) -> tuple[Rundeck]:
6350		return tuple([Rundeck(rundeckCol) for rundeckCol in self._Entity])
def AddRundeck(self, inputPath: str, resultPath: str = None) -> Rundeck:
6352	def AddRundeck(self, inputPath: str, resultPath: str = None) -> Rundeck:
6353		return Rundeck(self._Entity.AddRundeck(inputPath, resultPath))
def ReassignPrimary(self, id: int) -> RundeckUpdateStatus:
6355	def ReassignPrimary(self, id: int) -> RundeckUpdateStatus:
6356		return RundeckUpdateStatus[self._Entity.ReassignPrimary(id).ToString()]
def RemoveRundeck(self, id: int) -> RundeckRemoveStatus:
6358	def RemoveRundeck(self, id: int) -> RundeckRemoveStatus:
6359		return RundeckRemoveStatus[self._Entity.RemoveRundeck(id).ToString()]
def UpdateAllRundecks( self, newPaths: list[RundeckPathPair]) -> RundeckBulkUpdateStatus:
6361	def UpdateAllRundecks(self, newPaths: list[RundeckPathPair]) -> RundeckBulkUpdateStatus:
6362		newPathsList = List[_api.RundeckPathPair]()
6363		if newPaths is not None:
6364			for thing in newPaths:
6365				if thing is not None:
6366					newPathsList.Add(thing._Entity)
6367		return RundeckBulkUpdateStatus[self._Entity.UpdateAllRundecks(newPathsList).ToString()]
def GetRundeckPathSetters(self) -> list[RundeckPathPair]:
6369	def GetRundeckPathSetters(self) -> list[RundeckPathPair]:
6370		'''
6371		Get RundeckPathSetters to be edited and input to UpdateAllRundecks.
6372		'''
6373		return [RundeckPathPair(rundeckPathPair) for rundeckPathPair in self._Entity.GetRundeckPathSetters()]

Get RundeckPathSetters to be edited and input to UpdateAllRundecks.

def ReplaceStringInAllPaths( self, stringToReplace: str, newString: str) -> RundeckBulkUpdateStatus:
6375	def ReplaceStringInAllPaths(self, stringToReplace: str, newString: str) -> RundeckBulkUpdateStatus:
6376		return RundeckBulkUpdateStatus[self._Entity.ReplaceStringInAllPaths(stringToReplace, newString).ToString()]
class SectionCutCol(hyperx.api.IdNameEntityCol[hyperx.api.SectionCut]):
6388class SectionCutCol(IdNameEntityCol[SectionCut]):
6389	def __init__(self, sectionCutCol: _api.SectionCutCol):
6390		self._Entity = sectionCutCol
6391		self._CollectedClass = SectionCut
6392
6393	@property
6394	def SectionCutColList(self) -> tuple[SectionCut]:
6395		return tuple([SectionCut(sectionCutCol) for sectionCutCol in self._Entity])
6396
6397	def Create(self, origin: Vector3d, normal: Vector3d, horizontal: Vector3d, name: str = None) -> SectionCut:
6398		return SectionCut(self._Entity.Create(origin._Entity, normal._Entity, horizontal._Entity, name))
6399
6400	def Delete(self, id: int) -> CollectionModificationStatus:
6401		return CollectionModificationStatus[self._Entity.Delete(id).ToString()]
6402
6403	@overload
6404	def Get(self, name: str) -> SectionCut: ...
6405
6406	@overload
6407	def Get(self, id: int) -> SectionCut: ...
6408
6409	def Get(self, item1 = None) -> SectionCut:
6410		if isinstance(item1, str):
6411			return SectionCut(super().Get(item1))
6412
6413		if isinstance(item1, int):
6414			return SectionCut(super().Get(item1))
6415
6416		return SectionCut(self._Entity.Get(item1))
6417
6418	def __getitem__(self, index: int):
6419		return self.SectionCutColList[index]
6420
6421	def __iter__(self):
6422		yield from self.SectionCutColList
6423
6424	def __len__(self):
6425		return len(self.SectionCutColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

SectionCutCol(sectionCutCol: HyperX.Scripting.SectionCutCol)
6389	def __init__(self, sectionCutCol: _api.SectionCutCol):
6390		self._Entity = sectionCutCol
6391		self._CollectedClass = SectionCut
SectionCutColList: tuple[SectionCut]
6393	@property
6394	def SectionCutColList(self) -> tuple[SectionCut]:
6395		return tuple([SectionCut(sectionCutCol) for sectionCutCol in self._Entity])
def Create( self, origin: Vector3d, normal: Vector3d, horizontal: Vector3d, name: str = None) -> SectionCut:
6397	def Create(self, origin: Vector3d, normal: Vector3d, horizontal: Vector3d, name: str = None) -> SectionCut:
6398		return SectionCut(self._Entity.Create(origin._Entity, normal._Entity, horizontal._Entity, name))
def Delete(self, id: int) -> CollectionModificationStatus:
6400	def Delete(self, id: int) -> CollectionModificationStatus:
6401		return CollectionModificationStatus[self._Entity.Delete(id).ToString()]
def Get(self, item1=None) -> SectionCut:
6409	def Get(self, item1 = None) -> SectionCut:
6410		if isinstance(item1, str):
6411			return SectionCut(super().Get(item1))
6412
6413		if isinstance(item1, int):
6414			return SectionCut(super().Get(item1))
6415
6416		return SectionCut(self._Entity.Get(item1))
6428class SetCol(ZoneJointContainerCol[Set]):
6429	def __init__(self, setCol: _api.SetCol):
6430		self._Entity = setCol
6431		self._CollectedClass = Set
6432
6433	@property
6434	def SetColList(self) -> tuple[Set]:
6435		return tuple([Set(setCol) for setCol in self._Entity])
6436
6437	def Create(self, name: str = None) -> Set:
6438		return Set(self._Entity.Create(name))
6439
6440	@overload
6441	def Get(self, name: str) -> Set: ...
6442
6443	@overload
6444	def Get(self, id: int) -> Set: ...
6445
6446	def Get(self, item1 = None) -> Set:
6447		if isinstance(item1, str):
6448			return Set(super().Get(item1))
6449
6450		if isinstance(item1, int):
6451			return Set(super().Get(item1))
6452
6453		return Set(self._Entity.Get(item1))
6454
6455	def __getitem__(self, index: int):
6456		return self.SetColList[index]
6457
6458	def __iter__(self):
6459		yield from self.SetColList
6460
6461	def __len__(self):
6462		return len(self.SetColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

SetCol(setCol: HyperX.Scripting.SetCol)
6429	def __init__(self, setCol: _api.SetCol):
6430		self._Entity = setCol
6431		self._CollectedClass = Set
SetColList: tuple[Set]
6433	@property
6434	def SetColList(self) -> tuple[Set]:
6435		return tuple([Set(setCol) for setCol in self._Entity])
def Create(self, name: str = None) -> Set:
6437	def Create(self, name: str = None) -> Set:
6438		return Set(self._Entity.Create(name))
def Get(self, item1=None) -> Set:
6446	def Get(self, item1 = None) -> Set:
6447		if isinstance(item1, str):
6448			return Set(super().Get(item1))
6449
6450		if isinstance(item1, int):
6451			return Set(super().Get(item1))
6452
6453		return Set(self._Entity.Get(item1))
6465class StructureCol(ZoneJointContainerCol[Structure]):
6466	def __init__(self, structureCol: _api.StructureCol):
6467		self._Entity = structureCol
6468		self._CollectedClass = Structure
6469
6470	@property
6471	def StructureColList(self) -> tuple[Structure]:
6472		return tuple([Structure(structureCol) for structureCol in self._Entity])
6473
6474	def Create(self, name: str = None) -> Structure:
6475		return Structure(self._Entity.Create(name))
6476
6477	@overload
6478	def DeleteStructure(self, structure: Structure) -> bool: ...
6479
6480	@overload
6481	def DeleteStructure(self, name: str) -> bool: ...
6482
6483	@overload
6484	def DeleteStructure(self, id: int) -> bool: ...
6485
6486	@overload
6487	def Get(self, name: str) -> Structure: ...
6488
6489	@overload
6490	def Get(self, id: int) -> Structure: ...
6491
6492	def DeleteStructure(self, item1 = None) -> bool:
6493		if isinstance(item1, Structure):
6494			return self._Entity.DeleteStructure(item1._Entity)
6495
6496		if isinstance(item1, str):
6497			return self._Entity.DeleteStructure(item1)
6498
6499		if isinstance(item1, int):
6500			return self._Entity.DeleteStructure(item1)
6501
6502		return self._Entity.DeleteStructure(item1._Entity)
6503
6504	def Get(self, item1 = None) -> Structure:
6505		if isinstance(item1, str):
6506			return Structure(super().Get(item1))
6507
6508		if isinstance(item1, int):
6509			return Structure(super().Get(item1))
6510
6511		return Structure(self._Entity.Get(item1))
6512
6513	def __getitem__(self, index: int):
6514		return self.StructureColList[index]
6515
6516	def __iter__(self):
6517		yield from self.StructureColList
6518
6519	def __len__(self):
6520		return len(self.StructureColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

StructureCol(structureCol: HyperX.Scripting.StructureCol)
6466	def __init__(self, structureCol: _api.StructureCol):
6467		self._Entity = structureCol
6468		self._CollectedClass = Structure
StructureColList: tuple[Structure]
6470	@property
6471	def StructureColList(self) -> tuple[Structure]:
6472		return tuple([Structure(structureCol) for structureCol in self._Entity])
def Create(self, name: str = None) -> Structure:
6474	def Create(self, name: str = None) -> Structure:
6475		return Structure(self._Entity.Create(name))
def DeleteStructure(self, item1=None) -> bool:
6492	def DeleteStructure(self, item1 = None) -> bool:
6493		if isinstance(item1, Structure):
6494			return self._Entity.DeleteStructure(item1._Entity)
6495
6496		if isinstance(item1, str):
6497			return self._Entity.DeleteStructure(item1)
6498
6499		if isinstance(item1, int):
6500			return self._Entity.DeleteStructure(item1)
6501
6502		return self._Entity.DeleteStructure(item1._Entity)
def Get(self, item1=None) -> Structure:
6504	def Get(self, item1 = None) -> Structure:
6505		if isinstance(item1, str):
6506			return Structure(super().Get(item1))
6507
6508		if isinstance(item1, int):
6509			return Structure(super().Get(item1))
6510
6511		return Structure(self._Entity.Get(item1))
class Project:
6523class Project:
6524	'''
6525	Represents a HyperX project within a database.
6526	'''
6527	def __init__(self, project: _api.Project):
6528		self._Entity = project
6529
6530	@property
6531	def HyperFea(self) -> HyperFea:
6532		result = self._Entity.HyperFea
6533		return HyperFea(result) if result is not None else None
6534
6535	@property
6536	def WorkingFolder(self) -> str:
6537		return self._Entity.WorkingFolder
6538
6539	@property
6540	def FemDataSet(self) -> FemDataSet:
6541		result = self._Entity.FemDataSet
6542		return FemDataSet(result) if result is not None else None
6543
6544	@property
6545	def Beams(self) -> ZoneCol:
6546		result = self._Entity.Beams
6547		return ZoneCol(result) if result is not None else None
6548
6549	@property
6550	def Id(self) -> int:
6551		return self._Entity.Id
6552
6553	@property
6554	def Joints(self) -> JointCol:
6555		result = self._Entity.Joints
6556		return JointCol(result) if result is not None else None
6557
6558	@property
6559	def Name(self) -> str:
6560		return self._Entity.Name
6561
6562	@property
6563	def Panels(self) -> ZoneCol:
6564		result = self._Entity.Panels
6565		return ZoneCol(result) if result is not None else None
6566
6567	@property
6568	def Rundecks(self) -> RundeckCol:
6569		result = self._Entity.Rundecks
6570		return RundeckCol(result) if result is not None else None
6571
6572	@property
6573	def Sets(self) -> SetCol:
6574		result = self._Entity.Sets
6575		return SetCol(result) if result is not None else None
6576
6577	@property
6578	def Structures(self) -> StructureCol:
6579		result = self._Entity.Structures
6580		return StructureCol(result) if result is not None else None
6581
6582	@property
6583	def Zones(self) -> ZoneCol:
6584		result = self._Entity.Zones
6585		return ZoneCol(result) if result is not None else None
6586
6587	@property
6588	def PanelSegments(self) -> PanelSegmentCol:
6589		result = self._Entity.PanelSegments
6590		return PanelSegmentCol(result) if result is not None else None
6591
6592	@property
6593	def SectionCuts(self) -> SectionCutCol:
6594		result = self._Entity.SectionCuts
6595		return SectionCutCol(result) if result is not None else None
6596
6597	@property
6598	def DesignLoads(self) -> DesignLoadCol:
6599		result = self._Entity.DesignLoads
6600		return DesignLoadCol(result) if result is not None else None
6601
6602	@property
6603	def DiscreteFieldTables(self) -> DiscreteFieldCol:
6604		result = self._Entity.DiscreteFieldTables
6605		return DiscreteFieldCol(result) if result is not None else None
6606
6607	@property
6608	def AnalysisProperties(self) -> AnalysisPropertyCol:
6609		result = self._Entity.AnalysisProperties
6610		return AnalysisPropertyCol(result) if result is not None else None
6611
6612	@property
6613	def DesignProperties(self) -> DesignPropertyCol:
6614		result = self._Entity.DesignProperties
6615		return DesignPropertyCol(result) if result is not None else None
6616
6617	@property
6618	def LoadProperties(self) -> LoadPropertyCol:
6619		result = self._Entity.LoadProperties
6620		return LoadPropertyCol(result) if result is not None else None
6621
6622	@property
6623	def FemFormat(self) -> types.ProjectModelFormat:
6624		return types.ProjectModelFormat[self._Entity.FemFormat.ToString()]
6625
6626	def Upload(self, uploadSetName: str, company: str, program: str, tags: list[str], notes: str, zoneIds: set[int], jointIds: set[int]) -> bool:
6627		tagsList = List[str]()
6628		if tags is not None:
6629			for thing in tags:
6630				if thing is not None:
6631					tagsList.Add(thing)
6632		zoneIdsSet = HashSet[int]()
6633		if zoneIds is not None:
6634			for thing in zoneIds:
6635				if thing is not None:
6636					zoneIdsSet.Add(thing)
6637		jointIdsSet = HashSet[int]()
6638		if jointIds is not None:
6639			for thing in jointIds:
6640				if thing is not None:
6641					jointIdsSet.Add(thing)
6642		return self._Entity.Upload(uploadSetName, company, program, tagsList, notes, zoneIdsSet, jointIdsSet)
6643
6644	def GetDashboardCompanies(self) -> list[str]:
6645		'''
6646		This method fetches an array of Dashboard company names that are available to the user who is currently logged in. The URL and authentication token are taken from the last
6647            Dashboard login made through HyperX.
6648		'''
6649		return list[str](self._Entity.GetDashboardCompanies())
6650
6651	def GetDashboardPrograms(self, companyName: str) -> list[str]:
6652		return list[str](self._Entity.GetDashboardPrograms(companyName))
6653
6654	def GetDashboardTags(self, companyName: str) -> list[str]:
6655		return list[str](self._Entity.GetDashboardTags(companyName))
6656
6657	def Dispose(self) -> None:
6658		return self._Entity.Dispose()
6659
6660	def ImportFem(self) -> None:
6661		return self._Entity.ImportFem()
6662
6663	def ImportFeaResults(self, alwaysImport: bool = False) -> str:
6664		return self._Entity.ImportFeaResults(alwaysImport)
6665
6666	def SetFemFormat(self, femFormat: types.ProjectModelFormat) -> None:
6667		return self._Entity.SetFemFormat(_types.ProjectModelFormat(femFormat.value))
6668
6669	def SetFemUnits(self, femForceId: DbForceUnit, femLengthId: DbLengthUnit, femMassId: DbMassUnit, femTemperatureId: DbTemperatureUnit) -> SetUnitsStatus:
6670		return SetUnitsStatus[self._Entity.SetFemUnits(_api.DbForceUnit(femForceId.value), _api.DbLengthUnit(femLengthId.value), _api.DbMassUnit(femMassId.value), _api.DbTemperatureUnit(femTemperatureId.value)).ToString()]
6671
6672	def SizeJoints(self, joints: list[Joint] = None) -> types.SimpleStatus:
6673		jointsList = List[_api.Joint]()
6674		if joints is not None:
6675			for thing in joints:
6676				if thing is not None:
6677					jointsList.Add(thing._Entity)
6678		return types.SimpleStatus(self._Entity.SizeJoints(joints if joints is None else jointsList))
6679
6680	def GetJointsWithoutResults(self, joints: list[Joint]) -> set[int]:
6681		jointsList = List[_api.Joint]()
6682		if joints is not None:
6683			for thing in joints:
6684				if thing is not None:
6685					jointsList.Add(thing._Entity)
6686		return set[int](self._Entity.GetJointsWithoutResults(jointsList))
6687
6688	@overload
6689	def AnalyzeZones(self, zones: list[Zone] = None) -> types.SimpleStatus: ...
6690
6691	@overload
6692	def AnalyzeZones(self, zoneIds: list[int]) -> types.SimpleStatus: ...
6693
6694	@overload
6695	def SizeZones(self, zones: list[Zone] = None) -> types.SimpleStatus: ...
6696
6697	@overload
6698	def SizeZones(self, zoneIds: list[int]) -> types.SimpleStatus: ...
6699
6700	def CreateNonFeaZone(self, category: types.FamilyCategory, name: str = None) -> Zone:
6701		result = self._Entity.CreateNonFeaZone(_types.FamilyCategory(category.value), name)
6702		thisClass = type(result).__name__
6703		givenClass = Zone
6704		for subclass in Zone.__subclasses__():
6705			if subclass.__name__ == thisClass:
6706				givenClass = subclass
6707		return givenClass(result)
6708
6709	def ReturnToUnusedFem(self, zoneNumbers: list[int] = None, jointIds: set[int] = None) -> None:
6710		zoneNumbersList = MakeCSharpIntList(zoneNumbers)
6711		jointIdsSet = HashSet[int]()
6712		if jointIds is not None:
6713			for thing in jointIds:
6714				if thing is not None:
6715					jointIdsSet.Add(thing)
6716		return self._Entity.ReturnToUnusedFem(zoneNumbers if zoneNumbers is None else zoneNumbersList, jointIds if jointIds is None else jointIdsSet)
6717
6718	def UnimportFemAsync(self) -> Task:
6719		return Task(self._Entity.UnimportFemAsync())
6720
6721	def ExportFem(self, destinationFolder: str) -> None:
6722		return self._Entity.ExportFem(destinationFolder)
6723
6724	def ImportCad(self, filePath: str) -> None:
6725		return self._Entity.ImportCad(filePath)
6726
6727	@overload
6728	def ExportCad(self, filePath: str) -> None: ...
6729
6730	@overload
6731	def ExportCad(self, cadIds: tuple[int], filePath: str) -> None: ...
6732
6733	def RegeneratePfem(self) -> None:
6734		'''
6735		Regenerates and displays the preview FEM. If running a script outside of the Script Runner,
6736            do not call this method
6737		'''
6738		return self._Entity.RegeneratePfem()
6739
6740	def AnalyzeZones(self, item1 = None) -> types.SimpleStatus:
6741		if isinstance(item1, list) and item1 and isinstance(item1[0], Zone):
6742			zonesList = List[_api.Zone]()
6743			if item1 is not None:
6744				for thing in item1:
6745					if thing is not None:
6746						zonesList.Add(thing._Entity)
6747			return types.SimpleStatus(self._Entity.AnalyzeZones(item1 if item1 is None else zonesList))
6748
6749		if isinstance(item1, list) and item1 and isinstance(item1[0], int):
6750			zoneIdsList = MakeCSharpIntList(item1)
6751			return types.SimpleStatus(self._Entity.AnalyzeZones(zoneIdsList))
6752
6753		return types.SimpleStatus(self._Entity.AnalyzeZones(item1))
6754
6755	def SizeZones(self, item1 = None) -> types.SimpleStatus:
6756		if isinstance(item1, list) and item1 and isinstance(item1[0], Zone):
6757			zonesList = List[_api.Zone]()
6758			if item1 is not None:
6759				for thing in item1:
6760					if thing is not None:
6761						zonesList.Add(thing._Entity)
6762			return types.SimpleStatus(self._Entity.SizeZones(item1 if item1 is None else zonesList))
6763
6764		if isinstance(item1, list) and item1 and isinstance(item1[0], int):
6765			zoneIdsList = MakeCSharpIntList(item1)
6766			return types.SimpleStatus(self._Entity.SizeZones(zoneIdsList))
6767
6768		return types.SimpleStatus(self._Entity.SizeZones(item1))
6769
6770	def ExportCad(self, item1 = None, item2 = None) -> None:
6771		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int) and isinstance(item2, str):
6772			cadIdsList = MakeCSharpIntList(item1)
6773			cadIdsEnumerable = IEnumerable(cadIdsList)
6774			return self._Entity.ExportCad(cadIdsEnumerable, item2)
6775
6776		if isinstance(item1, str):
6777			return self._Entity.ExportCad(item1)
6778
6779		return self._Entity.ExportCad(item1, item2)

Represents a HyperX project within a database.

Project(project: HyperX.Scripting.Project)
6527	def __init__(self, project: _api.Project):
6528		self._Entity = project
HyperFea: <property object at 0x000001C375CC72E0>
6530	@property
6531	def HyperFea(self) -> HyperFea:
6532		result = self._Entity.HyperFea
6533		return HyperFea(result) if result is not None else None
WorkingFolder: str
6535	@property
6536	def WorkingFolder(self) -> str:
6537		return self._Entity.WorkingFolder
FemDataSet: <property object at 0x000001C375CC7560>
6539	@property
6540	def FemDataSet(self) -> FemDataSet:
6541		result = self._Entity.FemDataSet
6542		return FemDataSet(result) if result is not None else None
Beams: ZoneCol
6544	@property
6545	def Beams(self) -> ZoneCol:
6546		result = self._Entity.Beams
6547		return ZoneCol(result) if result is not None else None
Id: int
6549	@property
6550	def Id(self) -> int:
6551		return self._Entity.Id
Joints: JointCol
6553	@property
6554	def Joints(self) -> JointCol:
6555		result = self._Entity.Joints
6556		return JointCol(result) if result is not None else None
Name: str
6558	@property
6559	def Name(self) -> str:
6560		return self._Entity.Name
Panels: ZoneCol
6562	@property
6563	def Panels(self) -> ZoneCol:
6564		result = self._Entity.Panels
6565		return ZoneCol(result) if result is not None else None
Rundecks: RundeckCol
6567	@property
6568	def Rundecks(self) -> RundeckCol:
6569		result = self._Entity.Rundecks
6570		return RundeckCol(result) if result is not None else None
Sets: SetCol
6572	@property
6573	def Sets(self) -> SetCol:
6574		result = self._Entity.Sets
6575		return SetCol(result) if result is not None else None
Structures: StructureCol
6577	@property
6578	def Structures(self) -> StructureCol:
6579		result = self._Entity.Structures
6580		return StructureCol(result) if result is not None else None
Zones: ZoneCol
6582	@property
6583	def Zones(self) -> ZoneCol:
6584		result = self._Entity.Zones
6585		return ZoneCol(result) if result is not None else None
PanelSegments: PanelSegmentCol
6587	@property
6588	def PanelSegments(self) -> PanelSegmentCol:
6589		result = self._Entity.PanelSegments
6590		return PanelSegmentCol(result) if result is not None else None
SectionCuts: SectionCutCol
6592	@property
6593	def SectionCuts(self) -> SectionCutCol:
6594		result = self._Entity.SectionCuts
6595		return SectionCutCol(result) if result is not None else None
DesignLoads: DesignLoadCol
6597	@property
6598	def DesignLoads(self) -> DesignLoadCol:
6599		result = self._Entity.DesignLoads
6600		return DesignLoadCol(result) if result is not None else None
DiscreteFieldTables: DiscreteFieldCol
6602	@property
6603	def DiscreteFieldTables(self) -> DiscreteFieldCol:
6604		result = self._Entity.DiscreteFieldTables
6605		return DiscreteFieldCol(result) if result is not None else None
AnalysisProperties: AnalysisPropertyCol
6607	@property
6608	def AnalysisProperties(self) -> AnalysisPropertyCol:
6609		result = self._Entity.AnalysisProperties
6610		return AnalysisPropertyCol(result) if result is not None else None
DesignProperties: DesignPropertyCol
6612	@property
6613	def DesignProperties(self) -> DesignPropertyCol:
6614		result = self._Entity.DesignProperties
6615		return DesignPropertyCol(result) if result is not None else None
LoadProperties: LoadPropertyCol
6617	@property
6618	def LoadProperties(self) -> LoadPropertyCol:
6619		result = self._Entity.LoadProperties
6620		return LoadPropertyCol(result) if result is not None else None
FemFormat: hyperx.api.types.ProjectModelFormat
6622	@property
6623	def FemFormat(self) -> types.ProjectModelFormat:
6624		return types.ProjectModelFormat[self._Entity.FemFormat.ToString()]
def Upload( self, uploadSetName: str, company: str, program: str, tags: list[str], notes: str, zoneIds: set[int], jointIds: set[int]) -> bool:
6626	def Upload(self, uploadSetName: str, company: str, program: str, tags: list[str], notes: str, zoneIds: set[int], jointIds: set[int]) -> bool:
6627		tagsList = List[str]()
6628		if tags is not None:
6629			for thing in tags:
6630				if thing is not None:
6631					tagsList.Add(thing)
6632		zoneIdsSet = HashSet[int]()
6633		if zoneIds is not None:
6634			for thing in zoneIds:
6635				if thing is not None:
6636					zoneIdsSet.Add(thing)
6637		jointIdsSet = HashSet[int]()
6638		if jointIds is not None:
6639			for thing in jointIds:
6640				if thing is not None:
6641					jointIdsSet.Add(thing)
6642		return self._Entity.Upload(uploadSetName, company, program, tagsList, notes, zoneIdsSet, jointIdsSet)
def GetDashboardCompanies(self) -> list[str]:
6644	def GetDashboardCompanies(self) -> list[str]:
6645		'''
6646		This method fetches an array of Dashboard company names that are available to the user who is currently logged in. The URL and authentication token are taken from the last
6647            Dashboard login made through HyperX.
6648		'''
6649		return list[str](self._Entity.GetDashboardCompanies())

This method fetches an array of Dashboard company names that are available to the user who is currently logged in. The URL and authentication token are taken from the last Dashboard login made through HyperX.

def GetDashboardPrograms(self, companyName: str) -> list[str]:
6651	def GetDashboardPrograms(self, companyName: str) -> list[str]:
6652		return list[str](self._Entity.GetDashboardPrograms(companyName))
def GetDashboardTags(self, companyName: str) -> list[str]:
6654	def GetDashboardTags(self, companyName: str) -> list[str]:
6655		return list[str](self._Entity.GetDashboardTags(companyName))
def Dispose(self) -> None:
6657	def Dispose(self) -> None:
6658		return self._Entity.Dispose()
def ImportFem(self) -> None:
6660	def ImportFem(self) -> None:
6661		return self._Entity.ImportFem()
def ImportFeaResults(self, alwaysImport: bool = False) -> str:
6663	def ImportFeaResults(self, alwaysImport: bool = False) -> str:
6664		return self._Entity.ImportFeaResults(alwaysImport)
def SetFemFormat(self, femFormat: hyperx.api.types.ProjectModelFormat) -> None:
6666	def SetFemFormat(self, femFormat: types.ProjectModelFormat) -> None:
6667		return self._Entity.SetFemFormat(_types.ProjectModelFormat(femFormat.value))
def SetFemUnits( self, femForceId: DbForceUnit, femLengthId: DbLengthUnit, femMassId: DbMassUnit, femTemperatureId: DbTemperatureUnit) -> SetUnitsStatus:
6669	def SetFemUnits(self, femForceId: DbForceUnit, femLengthId: DbLengthUnit, femMassId: DbMassUnit, femTemperatureId: DbTemperatureUnit) -> SetUnitsStatus:
6670		return SetUnitsStatus[self._Entity.SetFemUnits(_api.DbForceUnit(femForceId.value), _api.DbLengthUnit(femLengthId.value), _api.DbMassUnit(femMassId.value), _api.DbTemperatureUnit(femTemperatureId.value)).ToString()]
def SizeJoints( self, joints: list[Joint] = None) -> hyperx.api.types.SimpleStatus:
6672	def SizeJoints(self, joints: list[Joint] = None) -> types.SimpleStatus:
6673		jointsList = List[_api.Joint]()
6674		if joints is not None:
6675			for thing in joints:
6676				if thing is not None:
6677					jointsList.Add(thing._Entity)
6678		return types.SimpleStatus(self._Entity.SizeJoints(joints if joints is None else jointsList))
def GetJointsWithoutResults(self, joints: list[Joint]) -> set[int]:
6680	def GetJointsWithoutResults(self, joints: list[Joint]) -> set[int]:
6681		jointsList = List[_api.Joint]()
6682		if joints is not None:
6683			for thing in joints:
6684				if thing is not None:
6685					jointsList.Add(thing._Entity)
6686		return set[int](self._Entity.GetJointsWithoutResults(jointsList))
def AnalyzeZones(self, item1=None) -> hyperx.api.types.SimpleStatus:
6740	def AnalyzeZones(self, item1 = None) -> types.SimpleStatus:
6741		if isinstance(item1, list) and item1 and isinstance(item1[0], Zone):
6742			zonesList = List[_api.Zone]()
6743			if item1 is not None:
6744				for thing in item1:
6745					if thing is not None:
6746						zonesList.Add(thing._Entity)
6747			return types.SimpleStatus(self._Entity.AnalyzeZones(item1 if item1 is None else zonesList))
6748
6749		if isinstance(item1, list) and item1 and isinstance(item1[0], int):
6750			zoneIdsList = MakeCSharpIntList(item1)
6751			return types.SimpleStatus(self._Entity.AnalyzeZones(zoneIdsList))
6752
6753		return types.SimpleStatus(self._Entity.AnalyzeZones(item1))
def SizeZones(self, item1=None) -> hyperx.api.types.SimpleStatus:
6755	def SizeZones(self, item1 = None) -> types.SimpleStatus:
6756		if isinstance(item1, list) and item1 and isinstance(item1[0], Zone):
6757			zonesList = List[_api.Zone]()
6758			if item1 is not None:
6759				for thing in item1:
6760					if thing is not None:
6761						zonesList.Add(thing._Entity)
6762			return types.SimpleStatus(self._Entity.SizeZones(item1 if item1 is None else zonesList))
6763
6764		if isinstance(item1, list) and item1 and isinstance(item1[0], int):
6765			zoneIdsList = MakeCSharpIntList(item1)
6766			return types.SimpleStatus(self._Entity.SizeZones(zoneIdsList))
6767
6768		return types.SimpleStatus(self._Entity.SizeZones(item1))
def CreateNonFeaZone( self, category: hyperx.api.types.FamilyCategory, name: str = None) -> Zone:
6700	def CreateNonFeaZone(self, category: types.FamilyCategory, name: str = None) -> Zone:
6701		result = self._Entity.CreateNonFeaZone(_types.FamilyCategory(category.value), name)
6702		thisClass = type(result).__name__
6703		givenClass = Zone
6704		for subclass in Zone.__subclasses__():
6705			if subclass.__name__ == thisClass:
6706				givenClass = subclass
6707		return givenClass(result)
def ReturnToUnusedFem(self, zoneNumbers: list[int] = None, jointIds: set[int] = None) -> None:
6709	def ReturnToUnusedFem(self, zoneNumbers: list[int] = None, jointIds: set[int] = None) -> None:
6710		zoneNumbersList = MakeCSharpIntList(zoneNumbers)
6711		jointIdsSet = HashSet[int]()
6712		if jointIds is not None:
6713			for thing in jointIds:
6714				if thing is not None:
6715					jointIdsSet.Add(thing)
6716		return self._Entity.ReturnToUnusedFem(zoneNumbers if zoneNumbers is None else zoneNumbersList, jointIds if jointIds is None else jointIdsSet)
def UnimportFemAsync(self) -> System.Threading.Tasks.Task:
6718	def UnimportFemAsync(self) -> Task:
6719		return Task(self._Entity.UnimportFemAsync())
def ExportFem(self, destinationFolder: str) -> None:
6721	def ExportFem(self, destinationFolder: str) -> None:
6722		return self._Entity.ExportFem(destinationFolder)
def ImportCad(self, filePath: str) -> None:
6724	def ImportCad(self, filePath: str) -> None:
6725		return self._Entity.ImportCad(filePath)
def ExportCad(self, item1=None, item2=None) -> None:
6770	def ExportCad(self, item1 = None, item2 = None) -> None:
6771		if isinstance(item1, tuple) and item1 and isinstance(item1[0], int) and isinstance(item2, str):
6772			cadIdsList = MakeCSharpIntList(item1)
6773			cadIdsEnumerable = IEnumerable(cadIdsList)
6774			return self._Entity.ExportCad(cadIdsEnumerable, item2)
6775
6776		if isinstance(item1, str):
6777			return self._Entity.ExportCad(item1)
6778
6779		return self._Entity.ExportCad(item1, item2)
def RegeneratePfem(self) -> None:
6733	def RegeneratePfem(self) -> None:
6734		'''
6735		Regenerates and displays the preview FEM. If running a script outside of the Script Runner,
6736            do not call this method
6737		'''
6738		return self._Entity.RegeneratePfem()

Regenerates and displays the preview FEM. If running a script outside of the Script Runner, do not call this method

class ProjectInfo(IdNameEntityRenameable):
6782class ProjectInfo(IdNameEntityRenameable):
6783	def __init__(self, projectInfo: _api.ProjectInfo):
6784		self._Entity = projectInfo

Represents an entity with an ID and Name.

ProjectInfo(projectInfo: HyperX.Scripting.ProjectInfo)
6783	def __init__(self, projectInfo: _api.ProjectInfo):
6784		self._Entity = projectInfo
class FailureModeCategoryCol(hyperx.api.IdNameEntityCol[hyperx.api.FailureModeCategory]):
6787class FailureModeCategoryCol(IdNameEntityCol[FailureModeCategory]):
6788	def __init__(self, failureModeCategoryCol: _api.FailureModeCategoryCol):
6789		self._Entity = failureModeCategoryCol
6790		self._CollectedClass = FailureModeCategory
6791
6792	@property
6793	def FailureModeCategoryColList(self) -> tuple[FailureModeCategory]:
6794		return tuple([FailureModeCategory(failureModeCategoryCol) for failureModeCategoryCol in self._Entity])
6795
6796	@overload
6797	def Get(self, name: str) -> FailureModeCategory: ...
6798
6799	@overload
6800	def Get(self, id: int) -> FailureModeCategory: ...
6801
6802	def Get(self, item1 = None) -> FailureModeCategory:
6803		if isinstance(item1, str):
6804			return FailureModeCategory(super().Get(item1))
6805
6806		if isinstance(item1, int):
6807			return FailureModeCategory(super().Get(item1))
6808
6809		return FailureModeCategory(self._Entity.Get(item1))
6810
6811	def __getitem__(self, index: int):
6812		return self.FailureModeCategoryColList[index]
6813
6814	def __iter__(self):
6815		yield from self.FailureModeCategoryColList
6816
6817	def __len__(self):
6818		return len(self.FailureModeCategoryColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

FailureModeCategoryCol(failureModeCategoryCol: HyperX.Scripting.FailureModeCategoryCol)
6788	def __init__(self, failureModeCategoryCol: _api.FailureModeCategoryCol):
6789		self._Entity = failureModeCategoryCol
6790		self._CollectedClass = FailureModeCategory
FailureModeCategoryColList: tuple[FailureModeCategory]
6792	@property
6793	def FailureModeCategoryColList(self) -> tuple[FailureModeCategory]:
6794		return tuple([FailureModeCategory(failureModeCategoryCol) for failureModeCategoryCol in self._Entity])
def Get(self, item1=None) -> FailureModeCategory:
6802	def Get(self, item1 = None) -> FailureModeCategory:
6803		if isinstance(item1, str):
6804			return FailureModeCategory(super().Get(item1))
6805
6806		if isinstance(item1, int):
6807			return FailureModeCategory(super().Get(item1))
6808
6809		return FailureModeCategory(self._Entity.Get(item1))
class FoamCol(typing.Generic[~T]):
6821class FoamCol(Generic[T]):
6822	def __init__(self, foamCol: _api.FoamCol):
6823		self._Entity = foamCol
6824
6825	@property
6826	def FoamColList(self) -> tuple[Foam]:
6827		return tuple([Foam(foamCol) for foamCol in self._Entity])
6828
6829	def Count(self) -> int:
6830		return self._Entity.Count()
6831
6832	def Get(self, materialName: str) -> Foam:
6833		return Foam(self._Entity.Get(materialName))
6834
6835	def Contains(self, materialName: str) -> bool:
6836		return self._Entity.Contains(materialName)
6837
6838	def Create(self, materialFamilyName: str, density: float, newMaterialName: str = None, femId: int = None) -> Foam:
6839		return Foam(self._Entity.Create(materialFamilyName, density, newMaterialName, femId))
6840
6841	def Copy(self, fmToCopyName: str, newMaterialName: str = None, femId: int = None) -> Foam:
6842		return Foam(self._Entity.Copy(fmToCopyName, newMaterialName, femId))
6843
6844	def Delete(self, materialName: str) -> bool:
6845		return self._Entity.Delete(materialName)
6846
6847	def __getitem__(self, index: int):
6848		return self.FoamColList[index]
6849
6850	def __iter__(self):
6851		yield from self.FoamColList
6852
6853	def __len__(self):
6854		return len(self.FoamColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

FoamCol(foamCol: HyperX.Scripting.FoamCol)
6822	def __init__(self, foamCol: _api.FoamCol):
6823		self._Entity = foamCol
FoamColList: tuple[Foam]
6825	@property
6826	def FoamColList(self) -> tuple[Foam]:
6827		return tuple([Foam(foamCol) for foamCol in self._Entity])
def Count(self) -> int:
6829	def Count(self) -> int:
6830		return self._Entity.Count()
def Get(self, materialName: str) -> Foam:
6832	def Get(self, materialName: str) -> Foam:
6833		return Foam(self._Entity.Get(materialName))
def Contains(self, materialName: str) -> bool:
6835	def Contains(self, materialName: str) -> bool:
6836		return self._Entity.Contains(materialName)
def Create( self, materialFamilyName: str, density: float, newMaterialName: str = None, femId: int = None) -> Foam:
6838	def Create(self, materialFamilyName: str, density: float, newMaterialName: str = None, femId: int = None) -> Foam:
6839		return Foam(self._Entity.Create(materialFamilyName, density, newMaterialName, femId))
def Copy( self, fmToCopyName: str, newMaterialName: str = None, femId: int = None) -> Foam:
6841	def Copy(self, fmToCopyName: str, newMaterialName: str = None, femId: int = None) -> Foam:
6842		return Foam(self._Entity.Copy(fmToCopyName, newMaterialName, femId))
def Delete(self, materialName: str) -> bool:
6844	def Delete(self, materialName: str) -> bool:
6845		return self._Entity.Delete(materialName)
class HoneycombCol(typing.Generic[~T]):
6857class HoneycombCol(Generic[T]):
6858	def __init__(self, honeycombCol: _api.HoneycombCol):
6859		self._Entity = honeycombCol
6860
6861	@property
6862	def HoneycombColList(self) -> tuple[Honeycomb]:
6863		return tuple([Honeycomb(honeycombCol) for honeycombCol in self._Entity])
6864
6865	def Count(self) -> int:
6866		return self._Entity.Count()
6867
6868	def Get(self, materialName: str) -> Honeycomb:
6869		return Honeycomb(self._Entity.Get(materialName))
6870
6871	def Contains(self, materialName: str) -> bool:
6872		return self._Entity.Contains(materialName)
6873
6874	def Create(self, materialFamilyName: str, density: float, newMaterialName: str = None, femId: int = None) -> Honeycomb:
6875		return Honeycomb(self._Entity.Create(materialFamilyName, density, newMaterialName, femId))
6876
6877	def Copy(self, honeyToCopyName: str, newMaterialName: str = None, femId: int = None) -> Honeycomb:
6878		return Honeycomb(self._Entity.Copy(honeyToCopyName, newMaterialName, femId))
6879
6880	def Delete(self, materialName: str) -> bool:
6881		return self._Entity.Delete(materialName)
6882
6883	def __getitem__(self, index: int):
6884		return self.HoneycombColList[index]
6885
6886	def __iter__(self):
6887		yield from self.HoneycombColList
6888
6889	def __len__(self):
6890		return len(self.HoneycombColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

HoneycombCol(honeycombCol: HyperX.Scripting.HoneycombCol)
6858	def __init__(self, honeycombCol: _api.HoneycombCol):
6859		self._Entity = honeycombCol
HoneycombColList: tuple[Honeycomb]
6861	@property
6862	def HoneycombColList(self) -> tuple[Honeycomb]:
6863		return tuple([Honeycomb(honeycombCol) for honeycombCol in self._Entity])
def Count(self) -> int:
6865	def Count(self) -> int:
6866		return self._Entity.Count()
def Get(self, materialName: str) -> Honeycomb:
6868	def Get(self, materialName: str) -> Honeycomb:
6869		return Honeycomb(self._Entity.Get(materialName))
def Contains(self, materialName: str) -> bool:
6871	def Contains(self, materialName: str) -> bool:
6872		return self._Entity.Contains(materialName)
def Create( self, materialFamilyName: str, density: float, newMaterialName: str = None, femId: int = None) -> Honeycomb:
6874	def Create(self, materialFamilyName: str, density: float, newMaterialName: str = None, femId: int = None) -> Honeycomb:
6875		return Honeycomb(self._Entity.Create(materialFamilyName, density, newMaterialName, femId))
def Copy( self, honeyToCopyName: str, newMaterialName: str = None, femId: int = None) -> Honeycomb:
6877	def Copy(self, honeyToCopyName: str, newMaterialName: str = None, femId: int = None) -> Honeycomb:
6878		return Honeycomb(self._Entity.Copy(honeyToCopyName, newMaterialName, femId))
def Delete(self, materialName: str) -> bool:
6880	def Delete(self, materialName: str) -> bool:
6881		return self._Entity.Delete(materialName)
class IsotropicCol(typing.Generic[~T]):
6893class IsotropicCol(Generic[T]):
6894	def __init__(self, isotropicCol: _api.IsotropicCol):
6895		self._Entity = isotropicCol
6896
6897	@property
6898	def IsotropicColList(self) -> tuple[Isotropic]:
6899		return tuple([Isotropic(isotropicCol) for isotropicCol in self._Entity])
6900
6901	def Count(self) -> int:
6902		return self._Entity.Count()
6903
6904	def Get(self, materialName: str) -> Isotropic:
6905		return Isotropic(self._Entity.Get(materialName))
6906
6907	def Contains(self, materialName: str) -> bool:
6908		return self._Entity.Contains(materialName)
6909
6910	def Create(self, materialFamilyName: str, density: float, newMaterialName: str = None, femId: int = None) -> Isotropic:
6911		return Isotropic(self._Entity.Create(materialFamilyName, density, newMaterialName, femId))
6912
6913	def Copy(self, isoToCopyName: str, newMaterialName: str = None, femId: int = None) -> Isotropic:
6914		return Isotropic(self._Entity.Copy(isoToCopyName, newMaterialName, femId))
6915
6916	def Delete(self, materialName: str) -> bool:
6917		return self._Entity.Delete(materialName)
6918
6919	def __getitem__(self, index: int):
6920		return self.IsotropicColList[index]
6921
6922	def __iter__(self):
6923		yield from self.IsotropicColList
6924
6925	def __len__(self):
6926		return len(self.IsotropicColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

IsotropicCol(isotropicCol: HyperX.Scripting.IsotropicCol)
6894	def __init__(self, isotropicCol: _api.IsotropicCol):
6895		self._Entity = isotropicCol
IsotropicColList: tuple[Isotropic]
6897	@property
6898	def IsotropicColList(self) -> tuple[Isotropic]:
6899		return tuple([Isotropic(isotropicCol) for isotropicCol in self._Entity])
def Count(self) -> int:
6901	def Count(self) -> int:
6902		return self._Entity.Count()
def Get(self, materialName: str) -> Isotropic:
6904	def Get(self, materialName: str) -> Isotropic:
6905		return Isotropic(self._Entity.Get(materialName))
def Contains(self, materialName: str) -> bool:
6907	def Contains(self, materialName: str) -> bool:
6908		return self._Entity.Contains(materialName)
def Create( self, materialFamilyName: str, density: float, newMaterialName: str = None, femId: int = None) -> Isotropic:
6910	def Create(self, materialFamilyName: str, density: float, newMaterialName: str = None, femId: int = None) -> Isotropic:
6911		return Isotropic(self._Entity.Create(materialFamilyName, density, newMaterialName, femId))
def Copy( self, isoToCopyName: str, newMaterialName: str = None, femId: int = None) -> Isotropic:
6913	def Copy(self, isoToCopyName: str, newMaterialName: str = None, femId: int = None) -> Isotropic:
6914		return Isotropic(self._Entity.Copy(isoToCopyName, newMaterialName, femId))
def Delete(self, materialName: str) -> bool:
6916	def Delete(self, materialName: str) -> bool:
6917		return self._Entity.Delete(materialName)
class LaminateFamilyCol(hyperx.api.IdNameEntityCol[hyperx.api.LaminateFamily]):
6929class LaminateFamilyCol(IdNameEntityCol[LaminateFamily]):
6930	def __init__(self, laminateFamilyCol: _api.LaminateFamilyCol):
6931		self._Entity = laminateFamilyCol
6932		self._CollectedClass = LaminateFamily
6933
6934	@property
6935	def LaminateFamilyColList(self) -> tuple[LaminateFamily]:
6936		return tuple([LaminateFamily(laminateFamilyCol) for laminateFamilyCol in self._Entity])
6937
6938	@overload
6939	def Get(self, name: str) -> LaminateFamily: ...
6940
6941	@overload
6942	def Get(self, id: int) -> LaminateFamily: ...
6943
6944	def Get(self, item1 = None) -> LaminateFamily:
6945		if isinstance(item1, str):
6946			return LaminateFamily(super().Get(item1))
6947
6948		if isinstance(item1, int):
6949			return LaminateFamily(super().Get(item1))
6950
6951		return LaminateFamily(self._Entity.Get(item1))
6952
6953	def __getitem__(self, index: int):
6954		return self.LaminateFamilyColList[index]
6955
6956	def __iter__(self):
6957		yield from self.LaminateFamilyColList
6958
6959	def __len__(self):
6960		return len(self.LaminateFamilyColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

LaminateFamilyCol(laminateFamilyCol: HyperX.Scripting.LaminateFamilyCol)
6930	def __init__(self, laminateFamilyCol: _api.LaminateFamilyCol):
6931		self._Entity = laminateFamilyCol
6932		self._CollectedClass = LaminateFamily
LaminateFamilyColList: tuple[LaminateFamily]
6934	@property
6935	def LaminateFamilyColList(self) -> tuple[LaminateFamily]:
6936		return tuple([LaminateFamily(laminateFamilyCol) for laminateFamilyCol in self._Entity])
def Get(self, item1=None) -> LaminateFamily:
6944	def Get(self, item1 = None) -> LaminateFamily:
6945		if isinstance(item1, str):
6946			return LaminateFamily(super().Get(item1))
6947
6948		if isinstance(item1, int):
6949			return LaminateFamily(super().Get(item1))
6950
6951		return LaminateFamily(self._Entity.Get(item1))
class LaminateCol(typing.Generic[~T]):
6963class LaminateCol(Generic[T]):
6964	def __init__(self, laminateCol: _api.LaminateCol):
6965		self._Entity = laminateCol
6966
6967	@property
6968	def LaminateColList(self) -> tuple[Laminate]:
6969		return tuple([Laminate(laminateCol) for laminateCol in self._Entity])
6970
6971	def Count(self) -> int:
6972		return self._Entity.Count()
6973
6974	def Get(self, laminateName: str) -> LaminateBase:
6975		result = self._Entity.Get(laminateName)
6976		thisClass = type(result).__name__
6977		givenClass = LaminateBase
6978		for subclass in LaminateBase.__subclasses__():
6979			if subclass.__name__ == thisClass:
6980				givenClass = subclass
6981		return givenClass(result)
6982
6983	def Contains(self, laminateName: str) -> bool:
6984		return self._Entity.Contains(laminateName)
6985
6986	def CreateLaminate(self, materialFamily: str, laminateName: str = None) -> Laminate:
6987		return Laminate(self._Entity.CreateLaminate(materialFamily, laminateName))
6988
6989	def CreateStiffenerLaminate(self, materialFamily: str, stiffenerProfile: types.StiffenerProfile, laminateName: str = None) -> StiffenerLaminate:
6990		return StiffenerLaminate(self._Entity.CreateStiffenerLaminate(materialFamily, _types.StiffenerProfile(stiffenerProfile.value), laminateName))
6991
6992	def Copy(self, laminateToCopyName: str, newLaminateName: str = None) -> LaminateBase:
6993		result = self._Entity.Copy(laminateToCopyName, newLaminateName)
6994		thisClass = type(result).__name__
6995		givenClass = LaminateBase
6996		for subclass in LaminateBase.__subclasses__():
6997			if subclass.__name__ == thisClass:
6998				givenClass = subclass
6999		return givenClass(result)
7000
7001	def Delete(self, name: str) -> bool:
7002		return self._Entity.Delete(name)
7003
7004	def GetLaminate(self, name: str) -> Laminate:
7005		return Laminate(self._Entity.GetLaminate(name))
7006
7007	def GetStiffenerLaminate(self, name: str) -> StiffenerLaminate:
7008		return StiffenerLaminate(self._Entity.GetStiffenerLaminate(name))
7009
7010	def __getitem__(self, index: int):
7011		return self.LaminateColList[index]
7012
7013	def __iter__(self):
7014		yield from self.LaminateColList
7015
7016	def __len__(self):
7017		return len(self.LaminateColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

LaminateCol(laminateCol: HyperX.Scripting.LaminateCol)
6964	def __init__(self, laminateCol: _api.LaminateCol):
6965		self._Entity = laminateCol
LaminateColList: tuple[Laminate]
6967	@property
6968	def LaminateColList(self) -> tuple[Laminate]:
6969		return tuple([Laminate(laminateCol) for laminateCol in self._Entity])
def Count(self) -> int:
6971	def Count(self) -> int:
6972		return self._Entity.Count()
def Get(self, laminateName: str) -> LaminateBase:
6974	def Get(self, laminateName: str) -> LaminateBase:
6975		result = self._Entity.Get(laminateName)
6976		thisClass = type(result).__name__
6977		givenClass = LaminateBase
6978		for subclass in LaminateBase.__subclasses__():
6979			if subclass.__name__ == thisClass:
6980				givenClass = subclass
6981		return givenClass(result)
def Contains(self, laminateName: str) -> bool:
6983	def Contains(self, laminateName: str) -> bool:
6984		return self._Entity.Contains(laminateName)
def CreateLaminate( self, materialFamily: str, laminateName: str = None) -> Laminate:
6986	def CreateLaminate(self, materialFamily: str, laminateName: str = None) -> Laminate:
6987		return Laminate(self._Entity.CreateLaminate(materialFamily, laminateName))
def CreateStiffenerLaminate( self, materialFamily: str, stiffenerProfile: hyperx.api.types.StiffenerProfile, laminateName: str = None) -> StiffenerLaminate:
6989	def CreateStiffenerLaminate(self, materialFamily: str, stiffenerProfile: types.StiffenerProfile, laminateName: str = None) -> StiffenerLaminate:
6990		return StiffenerLaminate(self._Entity.CreateStiffenerLaminate(materialFamily, _types.StiffenerProfile(stiffenerProfile.value), laminateName))
def Copy( self, laminateToCopyName: str, newLaminateName: str = None) -> LaminateBase:
6992	def Copy(self, laminateToCopyName: str, newLaminateName: str = None) -> LaminateBase:
6993		result = self._Entity.Copy(laminateToCopyName, newLaminateName)
6994		thisClass = type(result).__name__
6995		givenClass = LaminateBase
6996		for subclass in LaminateBase.__subclasses__():
6997			if subclass.__name__ == thisClass:
6998				givenClass = subclass
6999		return givenClass(result)
def Delete(self, name: str) -> bool:
7001	def Delete(self, name: str) -> bool:
7002		return self._Entity.Delete(name)
def GetLaminate(self, name: str) -> Laminate:
7004	def GetLaminate(self, name: str) -> Laminate:
7005		return Laminate(self._Entity.GetLaminate(name))
def GetStiffenerLaminate(self, name: str) -> StiffenerLaminate:
7007	def GetStiffenerLaminate(self, name: str) -> StiffenerLaminate:
7008		return StiffenerLaminate(self._Entity.GetStiffenerLaminate(name))
class OrthotropicCol(typing.Generic[~T]):
7020class OrthotropicCol(Generic[T]):
7021	def __init__(self, orthotropicCol: _api.OrthotropicCol):
7022		self._Entity = orthotropicCol
7023
7024	@property
7025	def OrthotropicColList(self) -> tuple[Orthotropic]:
7026		return tuple([Orthotropic(orthotropicCol) for orthotropicCol in self._Entity])
7027
7028	def Count(self) -> int:
7029		return self._Entity.Count()
7030
7031	def Get(self, materialName: str) -> Orthotropic:
7032		return Orthotropic(self._Entity.Get(materialName))
7033
7034	def Contains(self, materialName: str) -> bool:
7035		return self._Entity.Contains(materialName)
7036
7037	def Create(self, materialFamilyName: str, thickness: float, density: float, newMaterialName: str = None, femId: int = None) -> Orthotropic:
7038		return Orthotropic(self._Entity.Create(materialFamilyName, thickness, density, newMaterialName, femId))
7039
7040	def Copy(self, orthoToCopyName: str, newMaterialName: str = None, femId: int = None) -> Orthotropic:
7041		return Orthotropic(self._Entity.Copy(orthoToCopyName, newMaterialName, femId))
7042
7043	def Delete(self, materialName: str) -> bool:
7044		return self._Entity.Delete(materialName)
7045
7046	def __getitem__(self, index: int):
7047		return self.OrthotropicColList[index]
7048
7049	def __iter__(self):
7050		yield from self.OrthotropicColList
7051
7052	def __len__(self):
7053		return len(self.OrthotropicColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

OrthotropicCol(orthotropicCol: HyperX.Scripting.OrthotropicCol)
7021	def __init__(self, orthotropicCol: _api.OrthotropicCol):
7022		self._Entity = orthotropicCol
OrthotropicColList: tuple[Orthotropic]
7024	@property
7025	def OrthotropicColList(self) -> tuple[Orthotropic]:
7026		return tuple([Orthotropic(orthotropicCol) for orthotropicCol in self._Entity])
def Count(self) -> int:
7028	def Count(self) -> int:
7029		return self._Entity.Count()
def Get(self, materialName: str) -> Orthotropic:
7031	def Get(self, materialName: str) -> Orthotropic:
7032		return Orthotropic(self._Entity.Get(materialName))
def Contains(self, materialName: str) -> bool:
7034	def Contains(self, materialName: str) -> bool:
7035		return self._Entity.Contains(materialName)
def Create( self, materialFamilyName: str, thickness: float, density: float, newMaterialName: str = None, femId: int = None) -> Orthotropic:
7037	def Create(self, materialFamilyName: str, thickness: float, density: float, newMaterialName: str = None, femId: int = None) -> Orthotropic:
7038		return Orthotropic(self._Entity.Create(materialFamilyName, thickness, density, newMaterialName, femId))
def Copy( self, orthoToCopyName: str, newMaterialName: str = None, femId: int = None) -> Orthotropic:
7040	def Copy(self, orthoToCopyName: str, newMaterialName: str = None, femId: int = None) -> Orthotropic:
7041		return Orthotropic(self._Entity.Copy(orthoToCopyName, newMaterialName, femId))
def Delete(self, materialName: str) -> bool:
7043	def Delete(self, materialName: str) -> bool:
7044		return self._Entity.Delete(materialName)
class PluginPackageCol(hyperx.api.IdNameEntityCol[hyperx.api.PluginPackage]):
7056class PluginPackageCol(IdNameEntityCol[PluginPackage]):
7057	def __init__(self, pluginPackageCol: _api.PluginPackageCol):
7058		self._Entity = pluginPackageCol
7059		self._CollectedClass = PluginPackage
7060
7061	@property
7062	def PluginPackageColList(self) -> tuple[PluginPackage]:
7063		return tuple([PluginPackage(pluginPackageCol) for pluginPackageCol in self._Entity])
7064
7065	def AddPluginPackage(self, path: str) -> PluginPackage:
7066		return PluginPackage(self._Entity.AddPluginPackage(path))
7067
7068	@overload
7069	def RemovePluginPackage(self, name: str) -> bool: ...
7070
7071	@overload
7072	def RemovePluginPackage(self, id: int) -> bool: ...
7073
7074	def ClearAllPluginPackages(self) -> None:
7075		'''
7076		Clears all packages out of the database
7077		'''
7078		return self._Entity.ClearAllPluginPackages()
7079
7080	def GetPluginPackages(self) -> list[PluginPackage]:
7081		'''
7082		Gets a list of package info
7083            Includes name, id, file path, version, description, and modification date
7084		'''
7085		return [PluginPackage(pluginPackage) for pluginPackage in self._Entity.GetPluginPackages()]
7086
7087	@overload
7088	def Get(self, name: str) -> PluginPackage: ...
7089
7090	@overload
7091	def Get(self, id: int) -> PluginPackage: ...
7092
7093	def RemovePluginPackage(self, item1 = None) -> bool:
7094		if isinstance(item1, str):
7095			return self._Entity.RemovePluginPackage(item1)
7096
7097		if isinstance(item1, int):
7098			return self._Entity.RemovePluginPackage(item1)
7099
7100		return self._Entity.RemovePluginPackage(item1)
7101
7102	def Get(self, item1 = None) -> PluginPackage:
7103		if isinstance(item1, str):
7104			return PluginPackage(super().Get(item1))
7105
7106		if isinstance(item1, int):
7107			return PluginPackage(super().Get(item1))
7108
7109		return PluginPackage(self._Entity.Get(item1))
7110
7111	def __getitem__(self, index: int):
7112		return self.PluginPackageColList[index]
7113
7114	def __iter__(self):
7115		yield from self.PluginPackageColList
7116
7117	def __len__(self):
7118		return len(self.PluginPackageColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

PluginPackageCol(pluginPackageCol: HyperX.Scripting.PluginPackageCol)
7057	def __init__(self, pluginPackageCol: _api.PluginPackageCol):
7058		self._Entity = pluginPackageCol
7059		self._CollectedClass = PluginPackage
PluginPackageColList: tuple[PluginPackage]
7061	@property
7062	def PluginPackageColList(self) -> tuple[PluginPackage]:
7063		return tuple([PluginPackage(pluginPackageCol) for pluginPackageCol in self._Entity])
def AddPluginPackage(self, path: str) -> PluginPackage:
7065	def AddPluginPackage(self, path: str) -> PluginPackage:
7066		return PluginPackage(self._Entity.AddPluginPackage(path))
def RemovePluginPackage(self, item1=None) -> bool:
7093	def RemovePluginPackage(self, item1 = None) -> bool:
7094		if isinstance(item1, str):
7095			return self._Entity.RemovePluginPackage(item1)
7096
7097		if isinstance(item1, int):
7098			return self._Entity.RemovePluginPackage(item1)
7099
7100		return self._Entity.RemovePluginPackage(item1)
def ClearAllPluginPackages(self) -> None:
7074	def ClearAllPluginPackages(self) -> None:
7075		'''
7076		Clears all packages out of the database
7077		'''
7078		return self._Entity.ClearAllPluginPackages()

Clears all packages out of the database

def GetPluginPackages(self) -> list[PluginPackage]:
7080	def GetPluginPackages(self) -> list[PluginPackage]:
7081		'''
7082		Gets a list of package info
7083            Includes name, id, file path, version, description, and modification date
7084		'''
7085		return [PluginPackage(pluginPackage) for pluginPackage in self._Entity.GetPluginPackages()]

Gets a list of package info Includes name, id, file path, version, description, and modification date

def Get(self, item1=None) -> PluginPackage:
7102	def Get(self, item1 = None) -> PluginPackage:
7103		if isinstance(item1, str):
7104			return PluginPackage(super().Get(item1))
7105
7106		if isinstance(item1, int):
7107			return PluginPackage(super().Get(item1))
7108
7109		return PluginPackage(self._Entity.Get(item1))
class ProjectInfoCol(hyperx.api.IdNameEntityCol[hyperx.api.ProjectInfo]):
7121class ProjectInfoCol(IdNameEntityCol[ProjectInfo]):
7122	def __init__(self, projectInfoCol: _api.ProjectInfoCol):
7123		self._Entity = projectInfoCol
7124		self._CollectedClass = ProjectInfo
7125
7126	@property
7127	def ProjectInfoColList(self) -> tuple[ProjectInfo]:
7128		return tuple([ProjectInfo(projectInfoCol) for projectInfoCol in self._Entity])
7129
7130	@overload
7131	def Get(self, name: str) -> ProjectInfo: ...
7132
7133	@overload
7134	def Get(self, id: int) -> ProjectInfo: ...
7135
7136	def Get(self, item1 = None) -> ProjectInfo:
7137		if isinstance(item1, str):
7138			return ProjectInfo(super().Get(item1))
7139
7140		if isinstance(item1, int):
7141			return ProjectInfo(super().Get(item1))
7142
7143		return ProjectInfo(self._Entity.Get(item1))
7144
7145	def __getitem__(self, index: int):
7146		return self.ProjectInfoColList[index]
7147
7148	def __iter__(self):
7149		yield from self.ProjectInfoColList
7150
7151	def __len__(self):
7152		return len(self.ProjectInfoColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

ProjectInfoCol(projectInfoCol: HyperX.Scripting.ProjectInfoCol)
7122	def __init__(self, projectInfoCol: _api.ProjectInfoCol):
7123		self._Entity = projectInfoCol
7124		self._CollectedClass = ProjectInfo
ProjectInfoColList: tuple[ProjectInfo]
7126	@property
7127	def ProjectInfoColList(self) -> tuple[ProjectInfo]:
7128		return tuple([ProjectInfo(projectInfoCol) for projectInfoCol in self._Entity])
def Get(self, item1=None) -> ProjectInfo:
7136	def Get(self, item1 = None) -> ProjectInfo:
7137		if isinstance(item1, str):
7138			return ProjectInfo(super().Get(item1))
7139
7140		if isinstance(item1, int):
7141			return ProjectInfo(super().Get(item1))
7142
7143		return ProjectInfo(self._Entity.Get(item1))
class Application:
7155class Application:
7156	'''
7157	HyperX scripting application.
7158            This API is not guaranteed to be thread-safe.
7159            Calls into a single application instance or its descendents are not safe to be called concurrently.
7160            
7161            However, it is safe enough for integration testing to have multiple
7162            application instances with a single process.
7163	'''
7164	def __init__(self, application: _api.Application):
7165		self._Entity = application
7166
7167	@property
7168	def UnitSystem(self) -> UnitSystem:
7169		'''
7170		Unit system specified when starting a scripting Application.
7171		'''
7172		result = self._Entity.UnitSystem
7173		return UnitSystem(result) if result is not None else None
7174
7175	@property
7176	def CompilationDate(self) -> str:
7177		return self._Entity.CompilationDate
7178
7179	@property
7180	def DatabasePath(self) -> str:
7181		return self._Entity.DatabasePath
7182
7183	@property
7184	def ActiveProject(self) -> Project:
7185		'''
7186		Represents a HyperX project within a database.
7187		'''
7188		result = self._Entity.ActiveProject
7189		return Project(result) if result is not None else None
7190
7191	@property
7192	def UiRunnerMode(self) -> bool:
7193		return self._Entity.UiRunnerMode
7194
7195	@property
7196	def Version(self) -> str:
7197		return self._Entity.Version
7198
7199	@property
7200	def FailureModeCategories(self) -> FailureModeCategoryCol:
7201		result = self._Entity.FailureModeCategories
7202		return FailureModeCategoryCol(result) if result is not None else None
7203
7204	@property
7205	def FailureModes(self) -> FailureModeCol:
7206		result = self._Entity.FailureModes
7207		return FailureModeCol(result) if result is not None else None
7208
7209	@property
7210	def Packages(self) -> PluginPackageCol:
7211		result = self._Entity.Packages
7212		return PluginPackageCol(result) if result is not None else None
7213
7214	@property
7215	def Foams(self) -> FoamCol:
7216		'''
7217		Contains a set of all foam materials in a database.
7218		'''
7219		result = self._Entity.Foams
7220		return FoamCol(result) if result is not None else None
7221
7222	@property
7223	def Honeycombs(self) -> HoneycombCol:
7224		'''
7225		Contains a set of all honeycomb materials in a database.
7226		'''
7227		result = self._Entity.Honeycombs
7228		return HoneycombCol(result) if result is not None else None
7229
7230	@property
7231	def Isotropics(self) -> IsotropicCol:
7232		'''
7233		Contains a set of all isotropic materials in a database.
7234		'''
7235		result = self._Entity.Isotropics
7236		return IsotropicCol(result) if result is not None else None
7237
7238	@property
7239	def Laminates(self) -> LaminateCol:
7240		result = self._Entity.Laminates
7241		return LaminateCol(result) if result is not None else None
7242
7243	@property
7244	def LaminateFamilies(self) -> LaminateFamilyCol:
7245		result = self._Entity.LaminateFamilies
7246		return LaminateFamilyCol(result) if result is not None else None
7247
7248	@property
7249	def AnalysisProperties(self) -> AnalysisPropertyCol:
7250		result = self._Entity.AnalysisProperties
7251		return AnalysisPropertyCol(result) if result is not None else None
7252
7253	@property
7254	def DesignProperties(self) -> DesignPropertyCol:
7255		result = self._Entity.DesignProperties
7256		return DesignPropertyCol(result) if result is not None else None
7257
7258	@property
7259	def LoadProperties(self) -> LoadPropertyCol:
7260		result = self._Entity.LoadProperties
7261		return LoadPropertyCol(result) if result is not None else None
7262
7263	@property
7264	def Orthotropics(self) -> OrthotropicCol:
7265		'''
7266		Contains a set of all orthotropic materials in a database.
7267		'''
7268		result = self._Entity.Orthotropics
7269		return OrthotropicCol(result) if result is not None else None
7270
7271	@property
7272	def ProjectInfos(self) -> ProjectInfoCol:
7273		'''
7274		Contains a set of all projects in a database.
7275		'''
7276		result = self._Entity.ProjectInfos
7277		return ProjectInfoCol(result) if result is not None else None
7278
7279	@property
7280	def UserName(self) -> str:
7281		return self._Entity.UserName
7282
7283	@UserName.setter
7284	def UserName(self, value: str) -> None:
7285		self._Entity.UserName = value
7286
7287	def CloseDatabase(self, delay: int = 0) -> None:
7288		return self._Entity.CloseDatabase(delay)
7289
7290	def CopyProject(self, projectId: int, newName: str = None, copyDesignProperties: bool = True, copyAnalysisProperties: bool = True, copyLoadProperties: bool = True, copyWorkingFolder: bool = True) -> ProjectInfo:
7291		return ProjectInfo(self._Entity.CopyProject(projectId, newName, copyDesignProperties, copyAnalysisProperties, copyLoadProperties, copyWorkingFolder))
7292
7293	def CreateDatabaseFromTemplate(self, templateName: str, newPath: str) -> None:
7294		return self._Entity.CreateDatabaseFromTemplate(templateName, newPath)
7295
7296	def CreateProject(self, projectName: str = None) -> ProjectInfo:
7297		return ProjectInfo(self._Entity.CreateProject(projectName))
7298
7299	def DeleteProject(self, projectName: str) -> ProjectDeletionStatus:
7300		return ProjectDeletionStatus[self._Entity.DeleteProject(projectName).ToString()]
7301
7302	def Dispose(self) -> None:
7303		'''
7304		Dispose of the application. Should be explicitly called after the application
7305            is no longer needed unless the application is wrapped with a using clause.
7306		'''
7307		return self._Entity.Dispose()
7308
7309	def GetAnalyses(self) -> dict[int, AnalysisDefinition]:
7310		'''
7311		Get all Analysis Definitions in the database.
7312		'''
7313		return dict[int, AnalysisDefinition](self._Entity.GetAnalyses())
7314
7315	def Login(self, userName: str, password: str = "") -> None:
7316		return self._Entity.Login(userName, password)
7317
7318	def Migrate(self, databasePath: str) -> str:
7319		return self._Entity.Migrate(databasePath)
7320
7321	def CheckDatabaseIsUpToDate(self, databasePath: str) -> bool:
7322		return self._Entity.CheckDatabaseIsUpToDate(databasePath)
7323
7324	def OpenDatabase(self, databasePath: str) -> None:
7325		return self._Entity.OpenDatabase(databasePath)
7326
7327	def SelectProject(self, projectName: str) -> Project:
7328		return Project(self._Entity.SelectProject(projectName))

HyperX scripting application. This API is not guaranteed to be thread-safe. Calls into a single application instance or its descendents are not safe to be called concurrently.

However, it is safe enough for integration testing to have multiple
application instances with a single process.
Application(application: HyperX.Scripting.Application)
7164	def __init__(self, application: _api.Application):
7165		self._Entity = application
UnitSystem: <property object at 0x000001C34F1F3BA0>
7167	@property
7168	def UnitSystem(self) -> UnitSystem:
7169		'''
7170		Unit system specified when starting a scripting Application.
7171		'''
7172		result = self._Entity.UnitSystem
7173		return UnitSystem(result) if result is not None else None

Unit system specified when starting a scripting Application.

CompilationDate: str
7175	@property
7176	def CompilationDate(self) -> str:
7177		return self._Entity.CompilationDate
DatabasePath: str
7179	@property
7180	def DatabasePath(self) -> str:
7181		return self._Entity.DatabasePath
ActiveProject: Project
7183	@property
7184	def ActiveProject(self) -> Project:
7185		'''
7186		Represents a HyperX project within a database.
7187		'''
7188		result = self._Entity.ActiveProject
7189		return Project(result) if result is not None else None

Represents a HyperX project within a database.

UiRunnerMode: bool
7191	@property
7192	def UiRunnerMode(self) -> bool:
7193		return self._Entity.UiRunnerMode
Version: str
7195	@property
7196	def Version(self) -> str:
7197		return self._Entity.Version
FailureModeCategories: FailureModeCategoryCol
7199	@property
7200	def FailureModeCategories(self) -> FailureModeCategoryCol:
7201		result = self._Entity.FailureModeCategories
7202		return FailureModeCategoryCol(result) if result is not None else None
FailureModes: FailureModeCol
7204	@property
7205	def FailureModes(self) -> FailureModeCol:
7206		result = self._Entity.FailureModes
7207		return FailureModeCol(result) if result is not None else None
Packages: PluginPackageCol
7209	@property
7210	def Packages(self) -> PluginPackageCol:
7211		result = self._Entity.Packages
7212		return PluginPackageCol(result) if result is not None else None
Foams: FoamCol
7214	@property
7215	def Foams(self) -> FoamCol:
7216		'''
7217		Contains a set of all foam materials in a database.
7218		'''
7219		result = self._Entity.Foams
7220		return FoamCol(result) if result is not None else None

Contains a set of all foam materials in a database.

Honeycombs: HoneycombCol
7222	@property
7223	def Honeycombs(self) -> HoneycombCol:
7224		'''
7225		Contains a set of all honeycomb materials in a database.
7226		'''
7227		result = self._Entity.Honeycombs
7228		return HoneycombCol(result) if result is not None else None

Contains a set of all honeycomb materials in a database.

Isotropics: IsotropicCol
7230	@property
7231	def Isotropics(self) -> IsotropicCol:
7232		'''
7233		Contains a set of all isotropic materials in a database.
7234		'''
7235		result = self._Entity.Isotropics
7236		return IsotropicCol(result) if result is not None else None

Contains a set of all isotropic materials in a database.

Laminates: LaminateCol
7238	@property
7239	def Laminates(self) -> LaminateCol:
7240		result = self._Entity.Laminates
7241		return LaminateCol(result) if result is not None else None
LaminateFamilies: LaminateFamilyCol
7243	@property
7244	def LaminateFamilies(self) -> LaminateFamilyCol:
7245		result = self._Entity.LaminateFamilies
7246		return LaminateFamilyCol(result) if result is not None else None
AnalysisProperties: AnalysisPropertyCol
7248	@property
7249	def AnalysisProperties(self) -> AnalysisPropertyCol:
7250		result = self._Entity.AnalysisProperties
7251		return AnalysisPropertyCol(result) if result is not None else None
DesignProperties: DesignPropertyCol
7253	@property
7254	def DesignProperties(self) -> DesignPropertyCol:
7255		result = self._Entity.DesignProperties
7256		return DesignPropertyCol(result) if result is not None else None
LoadProperties: LoadPropertyCol
7258	@property
7259	def LoadProperties(self) -> LoadPropertyCol:
7260		result = self._Entity.LoadProperties
7261		return LoadPropertyCol(result) if result is not None else None
Orthotropics: OrthotropicCol
7263	@property
7264	def Orthotropics(self) -> OrthotropicCol:
7265		'''
7266		Contains a set of all orthotropic materials in a database.
7267		'''
7268		result = self._Entity.Orthotropics
7269		return OrthotropicCol(result) if result is not None else None

Contains a set of all orthotropic materials in a database.

ProjectInfos: ProjectInfoCol
7271	@property
7272	def ProjectInfos(self) -> ProjectInfoCol:
7273		'''
7274		Contains a set of all projects in a database.
7275		'''
7276		result = self._Entity.ProjectInfos
7277		return ProjectInfoCol(result) if result is not None else None

Contains a set of all projects in a database.

UserName: str
7279	@property
7280	def UserName(self) -> str:
7281		return self._Entity.UserName
def CloseDatabase(self, delay: int = 0) -> None:
7287	def CloseDatabase(self, delay: int = 0) -> None:
7288		return self._Entity.CloseDatabase(delay)
def CopyProject( self, projectId: int, newName: str = None, copyDesignProperties: bool = True, copyAnalysisProperties: bool = True, copyLoadProperties: bool = True, copyWorkingFolder: bool = True) -> ProjectInfo:
7290	def CopyProject(self, projectId: int, newName: str = None, copyDesignProperties: bool = True, copyAnalysisProperties: bool = True, copyLoadProperties: bool = True, copyWorkingFolder: bool = True) -> ProjectInfo:
7291		return ProjectInfo(self._Entity.CopyProject(projectId, newName, copyDesignProperties, copyAnalysisProperties, copyLoadProperties, copyWorkingFolder))
def CreateDatabaseFromTemplate(self, templateName: str, newPath: str) -> None:
7293	def CreateDatabaseFromTemplate(self, templateName: str, newPath: str) -> None:
7294		return self._Entity.CreateDatabaseFromTemplate(templateName, newPath)
def CreateProject(self, projectName: str = None) -> ProjectInfo:
7296	def CreateProject(self, projectName: str = None) -> ProjectInfo:
7297		return ProjectInfo(self._Entity.CreateProject(projectName))
def DeleteProject(self, projectName: str) -> ProjectDeletionStatus:
7299	def DeleteProject(self, projectName: str) -> ProjectDeletionStatus:
7300		return ProjectDeletionStatus[self._Entity.DeleteProject(projectName).ToString()]
def Dispose(self) -> None:
7302	def Dispose(self) -> None:
7303		'''
7304		Dispose of the application. Should be explicitly called after the application
7305            is no longer needed unless the application is wrapped with a using clause.
7306		'''
7307		return self._Entity.Dispose()

Dispose of the application. Should be explicitly called after the application is no longer needed unless the application is wrapped with a using clause.

def GetAnalyses(self) -> dict[int, AnalysisDefinition]:
7309	def GetAnalyses(self) -> dict[int, AnalysisDefinition]:
7310		'''
7311		Get all Analysis Definitions in the database.
7312		'''
7313		return dict[int, AnalysisDefinition](self._Entity.GetAnalyses())

Get all Analysis Definitions in the database.

def Login(self, userName: str, password: str = '') -> None:
7315	def Login(self, userName: str, password: str = "") -> None:
7316		return self._Entity.Login(userName, password)
def Migrate(self, databasePath: str) -> str:
7318	def Migrate(self, databasePath: str) -> str:
7319		return self._Entity.Migrate(databasePath)
def CheckDatabaseIsUpToDate(self, databasePath: str) -> bool:
7321	def CheckDatabaseIsUpToDate(self, databasePath: str) -> bool:
7322		return self._Entity.CheckDatabaseIsUpToDate(databasePath)
def OpenDatabase(self, databasePath: str) -> None:
7324	def OpenDatabase(self, databasePath: str) -> None:
7325		return self._Entity.OpenDatabase(databasePath)
def SelectProject(self, projectName: str) -> Project:
7327	def SelectProject(self, projectName: str) -> Project:
7328		return Project(self._Entity.SelectProject(projectName))
class JointDesignProperty(DesignProperty):
7331class JointDesignProperty(DesignProperty):
7332	def __init__(self, jointDesignProperty: _api.JointDesignProperty):
7333		self._Entity = jointDesignProperty

Represents an entity with an ID and Name.

JointDesignProperty(jointDesignProperty: HyperX.Scripting.JointDesignProperty)
7332	def __init__(self, jointDesignProperty: _api.JointDesignProperty):
7333		self._Entity = jointDesignProperty
class SizingMaterial(IdEntity):
7336class SizingMaterial(IdEntity):
7337	def __init__(self, sizingMaterial: _api.SizingMaterial):
7338		self._Entity = sizingMaterial
7339
7340	@property
7341	def MaterialId(self) -> int:
7342		return self._Entity.MaterialId
7343
7344	@property
7345	def MaterialType(self) -> types.MaterialType:
7346		'''
7347		Represents a material's type.
7348		'''
7349		return types.MaterialType[self._Entity.MaterialType.ToString()]

Represents an entity with an ID.

SizingMaterial(sizingMaterial: HyperX.Scripting.SizingMaterial)
7337	def __init__(self, sizingMaterial: _api.SizingMaterial):
7338		self._Entity = sizingMaterial
MaterialId: int
7340	@property
7341	def MaterialId(self) -> int:
7342		return self._Entity.MaterialId
MaterialType: hyperx.api.types.MaterialType
7344	@property
7345	def MaterialType(self) -> types.MaterialType:
7346		'''
7347		Represents a material's type.
7348		'''
7349		return types.MaterialType[self._Entity.MaterialType.ToString()]

Represents a material's type.

Inherited Members
IdEntity
Id
class SizingMaterialCol(hyperx.api.IdEntityCol[hyperx.api.SizingMaterial]):
7352class SizingMaterialCol(IdEntityCol[SizingMaterial]):
7353	def __init__(self, sizingMaterialCol: _api.SizingMaterialCol):
7354		self._Entity = sizingMaterialCol
7355		self._CollectedClass = SizingMaterial
7356
7357	@property
7358	def SizingMaterialColList(self) -> tuple[SizingMaterial]:
7359		return tuple([SizingMaterial(sizingMaterialCol) for sizingMaterialCol in self._Entity])
7360
7361	@overload
7362	def Get(self, name: str) -> SizingMaterial: ...
7363
7364	@overload
7365	def Contains(self, name: str) -> bool: ...
7366
7367	@overload
7368	def AddSizingMaterial(self, materialId: int) -> bool: ...
7369
7370	@overload
7371	def AddSizingMaterial(self, name: str) -> bool: ...
7372
7373	@overload
7374	def RemoveSizingMaterial(self, materialId: int) -> bool: ...
7375
7376	@overload
7377	def RemoveSizingMaterial(self, name: str) -> bool: ...
7378
7379	@overload
7380	def Contains(self, id: int) -> bool: ...
7381
7382	@overload
7383	def Get(self, id: int) -> SizingMaterial: ...
7384
7385	def Get(self, item1 = None) -> SizingMaterial:
7386		if isinstance(item1, str):
7387			return SizingMaterial(self._Entity.Get(item1))
7388
7389		if isinstance(item1, int):
7390			return SizingMaterial(super().Get(item1))
7391
7392		return SizingMaterial(self._Entity.Get(item1))
7393
7394	def Contains(self, item1 = None) -> bool:
7395		if isinstance(item1, str):
7396			return self._Entity.Contains(item1)
7397
7398		if isinstance(item1, int):
7399			return bool(super().Contains(item1))
7400
7401		return self._Entity.Contains(item1)
7402
7403	def AddSizingMaterial(self, item1 = None) -> bool:
7404		if isinstance(item1, int):
7405			return self._Entity.AddSizingMaterial(item1)
7406
7407		if isinstance(item1, str):
7408			return self._Entity.AddSizingMaterial(item1)
7409
7410		return self._Entity.AddSizingMaterial(item1)
7411
7412	def RemoveSizingMaterial(self, item1 = None) -> bool:
7413		if isinstance(item1, int):
7414			return self._Entity.RemoveSizingMaterial(item1)
7415
7416		if isinstance(item1, str):
7417			return self._Entity.RemoveSizingMaterial(item1)
7418
7419		return self._Entity.RemoveSizingMaterial(item1)
7420
7421	def __getitem__(self, index: int):
7422		return self.SizingMaterialColList[index]
7423
7424	def __iter__(self):
7425		yield from self.SizingMaterialColList
7426
7427	def __len__(self):
7428		return len(self.SizingMaterialColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

SizingMaterialCol(sizingMaterialCol: HyperX.Scripting.SizingMaterialCol)
7353	def __init__(self, sizingMaterialCol: _api.SizingMaterialCol):
7354		self._Entity = sizingMaterialCol
7355		self._CollectedClass = SizingMaterial
SizingMaterialColList: tuple[SizingMaterial]
7357	@property
7358	def SizingMaterialColList(self) -> tuple[SizingMaterial]:
7359		return tuple([SizingMaterial(sizingMaterialCol) for sizingMaterialCol in self._Entity])
def Get(self, item1=None) -> SizingMaterial:
7385	def Get(self, item1 = None) -> SizingMaterial:
7386		if isinstance(item1, str):
7387			return SizingMaterial(self._Entity.Get(item1))
7388
7389		if isinstance(item1, int):
7390			return SizingMaterial(super().Get(item1))
7391
7392		return SizingMaterial(self._Entity.Get(item1))
def Contains(self, item1=None) -> bool:
7394	def Contains(self, item1 = None) -> bool:
7395		if isinstance(item1, str):
7396			return self._Entity.Contains(item1)
7397
7398		if isinstance(item1, int):
7399			return bool(super().Contains(item1))
7400
7401		return self._Entity.Contains(item1)
def AddSizingMaterial(self, item1=None) -> bool:
7403	def AddSizingMaterial(self, item1 = None) -> bool:
7404		if isinstance(item1, int):
7405			return self._Entity.AddSizingMaterial(item1)
7406
7407		if isinstance(item1, str):
7408			return self._Entity.AddSizingMaterial(item1)
7409
7410		return self._Entity.AddSizingMaterial(item1)
def RemoveSizingMaterial(self, item1=None) -> bool:
7412	def RemoveSizingMaterial(self, item1 = None) -> bool:
7413		if isinstance(item1, int):
7414			return self._Entity.RemoveSizingMaterial(item1)
7415
7416		if isinstance(item1, str):
7417			return self._Entity.RemoveSizingMaterial(item1)
7418
7419		return self._Entity.RemoveSizingMaterial(item1)
Inherited Members
IdEntityCol
IdEntityColList
Ids
Count
class ZoneOverride(IdEntity):
7431class ZoneOverride(IdEntity):
7432	def __init__(self, zoneOverride: _api.ZoneOverride):
7433		self._Entity = zoneOverride
7434
7435	@property
7436	def AllowMaterials(self) -> bool:
7437		return self._Entity.AllowMaterials
7438
7439	@property
7440	def ProjectId(self) -> int:
7441		return self._Entity.ProjectId
7442
7443	@property
7444	def DesignId(self) -> int:
7445		return self._Entity.DesignId
7446
7447	@property
7448	def FamilyId(self) -> types.BeamPanelFamily:
7449		return types.BeamPanelFamily[self._Entity.FamilyId.ToString()]
7450
7451	@property
7452	def ConceptId(self) -> int:
7453		return self._Entity.ConceptId
7454
7455	@property
7456	def VariableId(self) -> int:
7457		return self._Entity.VariableId
7458
7459	@property
7460	def MinBound(self) -> float:
7461		return self._Entity.MinBound
7462
7463	@property
7464	def MaxBound(self) -> float:
7465		return self._Entity.MaxBound
7466
7467	@property
7468	def StepSize(self) -> float:
7469		return self._Entity.StepSize
7470
7471	@property
7472	def MinPlies(self) -> int:
7473		return self._Entity.MinPlies
7474
7475	@property
7476	def MaxPlies(self) -> int:
7477		return self._Entity.MaxPlies
7478
7479	@property
7480	def PlyStepSize(self) -> int:
7481		return self._Entity.PlyStepSize
7482
7483	@property
7484	def InputMode(self) -> types.VariableInputMode:
7485		return types.VariableInputMode[self._Entity.InputMode.ToString()]
7486
7487	@property
7488	def SizingMaterials(self) -> SizingMaterialCol:
7489		result = self._Entity.SizingMaterials
7490		return SizingMaterialCol(result) if result is not None else None
7491
7492	@property
7493	def AnalysisValue(self) -> float:
7494		return self._Entity.AnalysisValue
7495
7496	@property
7497	def AnalysisMaterial(self) -> str:
7498		return self._Entity.AnalysisMaterial
7499
7500	@property
7501	def AnalysisMaterialType(self) -> types.MaterialType:
7502		return types.MaterialType[self._Entity.AnalysisMaterialType.ToString()]
7503
7504	@MinBound.setter
7505	def MinBound(self, value: float) -> None:
7506		self._Entity.MinBound = value
7507
7508	@MaxBound.setter
7509	def MaxBound(self, value: float) -> None:
7510		self._Entity.MaxBound = value
7511
7512	@StepSize.setter
7513	def StepSize(self, value: float) -> None:
7514		self._Entity.StepSize = value
7515
7516	@MinPlies.setter
7517	def MinPlies(self, value: int) -> None:
7518		self._Entity.MinPlies = value
7519
7520	@MaxPlies.setter
7521	def MaxPlies(self, value: int) -> None:
7522		self._Entity.MaxPlies = value
7523
7524	@PlyStepSize.setter
7525	def PlyStepSize(self, value: int) -> None:
7526		self._Entity.PlyStepSize = value
7527
7528	@AnalysisValue.setter
7529	def AnalysisValue(self, value: float) -> None:
7530		self._Entity.AnalysisValue = value
7531
7532	@AnalysisMaterial.setter
7533	def AnalysisMaterial(self, value: str) -> None:
7534		self._Entity.AnalysisMaterial = value

Represents an entity with an ID.

ZoneOverride(zoneOverride: HyperX.Scripting.ZoneOverride)
7432	def __init__(self, zoneOverride: _api.ZoneOverride):
7433		self._Entity = zoneOverride
AllowMaterials: bool
7435	@property
7436	def AllowMaterials(self) -> bool:
7437		return self._Entity.AllowMaterials
ProjectId: int
7439	@property
7440	def ProjectId(self) -> int:
7441		return self._Entity.ProjectId
DesignId: int
7443	@property
7444	def DesignId(self) -> int:
7445		return self._Entity.DesignId
FamilyId: hyperx.api.types.BeamPanelFamily
7447	@property
7448	def FamilyId(self) -> types.BeamPanelFamily:
7449		return types.BeamPanelFamily[self._Entity.FamilyId.ToString()]
ConceptId: int
7451	@property
7452	def ConceptId(self) -> int:
7453		return self._Entity.ConceptId
VariableId: int
7455	@property
7456	def VariableId(self) -> int:
7457		return self._Entity.VariableId
MinBound: float
7459	@property
7460	def MinBound(self) -> float:
7461		return self._Entity.MinBound
MaxBound: float
7463	@property
7464	def MaxBound(self) -> float:
7465		return self._Entity.MaxBound
StepSize: float
7467	@property
7468	def StepSize(self) -> float:
7469		return self._Entity.StepSize
MinPlies: int
7471	@property
7472	def MinPlies(self) -> int:
7473		return self._Entity.MinPlies
MaxPlies: int
7475	@property
7476	def MaxPlies(self) -> int:
7477		return self._Entity.MaxPlies
PlyStepSize: int
7479	@property
7480	def PlyStepSize(self) -> int:
7481		return self._Entity.PlyStepSize
InputMode: hyperx.api.types.VariableInputMode
7483	@property
7484	def InputMode(self) -> types.VariableInputMode:
7485		return types.VariableInputMode[self._Entity.InputMode.ToString()]
SizingMaterials: SizingMaterialCol
7487	@property
7488	def SizingMaterials(self) -> SizingMaterialCol:
7489		result = self._Entity.SizingMaterials
7490		return SizingMaterialCol(result) if result is not None else None
AnalysisValue: float
7492	@property
7493	def AnalysisValue(self) -> float:
7494		return self._Entity.AnalysisValue
AnalysisMaterial: str
7496	@property
7497	def AnalysisMaterial(self) -> str:
7498		return self._Entity.AnalysisMaterial
AnalysisMaterialType: hyperx.api.types.MaterialType
7500	@property
7501	def AnalysisMaterialType(self) -> types.MaterialType:
7502		return types.MaterialType[self._Entity.AnalysisMaterialType.ToString()]
Inherited Members
IdEntity
Id
class ToolingConstraint(IdNameEntity):
7537class ToolingConstraint(IdNameEntity):
7538	'''
7539	Tooling constraints are a feature of Design Properties for Zones.
7540	'''
7541	def __init__(self, toolingConstraint: _api.ToolingConstraint):
7542		self._Entity = toolingConstraint
7543
7544	@property
7545	def ConstraintMax(self) -> float:
7546		return self._Entity.ConstraintMax
7547
7548	@property
7549	def ConstraintMin(self) -> float:
7550		return self._Entity.ConstraintMin
7551
7552	@property
7553	def ConstraintValue(self) -> float:
7554		return self._Entity.ConstraintValue
7555
7556	@property
7557	def ToolingSelectionType(self) -> types.ToolingSelectionType:
7558		'''
7559		Defines which selection a given tooling constraint is currently set to.
7560		'''
7561		return types.ToolingSelectionType[self._Entity.ToolingSelectionType.ToString()]
7562
7563	def SetToAnyValue(self) -> None:
7564		return self._Entity.SetToAnyValue()
7565
7566	def SetToInequality(self, value: float) -> None:
7567		return self._Entity.SetToInequality(value)
7568
7569	def SetToRange(self, min: float, max: float) -> None:
7570		return self._Entity.SetToRange(min, max)
7571
7572	def SetToValue(self, value: float) -> None:
7573		return self._Entity.SetToValue(value)

Tooling constraints are a feature of Design Properties for Zones.

ToolingConstraint(toolingConstraint: HyperX.Scripting.ToolingConstraint)
7541	def __init__(self, toolingConstraint: _api.ToolingConstraint):
7542		self._Entity = toolingConstraint
ConstraintMax: float
7544	@property
7545	def ConstraintMax(self) -> float:
7546		return self._Entity.ConstraintMax
ConstraintMin: float
7548	@property
7549	def ConstraintMin(self) -> float:
7550		return self._Entity.ConstraintMin
ConstraintValue: float
7552	@property
7553	def ConstraintValue(self) -> float:
7554		return self._Entity.ConstraintValue
ToolingSelectionType: hyperx.api.types.ToolingSelectionType
7556	@property
7557	def ToolingSelectionType(self) -> types.ToolingSelectionType:
7558		'''
7559		Defines which selection a given tooling constraint is currently set to.
7560		'''
7561		return types.ToolingSelectionType[self._Entity.ToolingSelectionType.ToString()]

Defines which selection a given tooling constraint is currently set to.

def SetToAnyValue(self) -> None:
7563	def SetToAnyValue(self) -> None:
7564		return self._Entity.SetToAnyValue()
def SetToInequality(self, value: float) -> None:
7566	def SetToInequality(self, value: float) -> None:
7567		return self._Entity.SetToInequality(value)
def SetToRange(self, min: float, max: float) -> None:
7569	def SetToRange(self, min: float, max: float) -> None:
7570		return self._Entity.SetToRange(min, max)
def SetToValue(self, value: float) -> None:
7572	def SetToValue(self, value: float) -> None:
7573		return self._Entity.SetToValue(value)
Inherited Members
IdNameEntity
Name
IdEntity
Id
class ZoneOverrideCol(hyperx.api.IdEntityCol[hyperx.api.ZoneOverride]):
7576class ZoneOverrideCol(IdEntityCol[ZoneOverride]):
7577	def __init__(self, zoneOverrideCol: _api.ZoneOverrideCol):
7578		self._Entity = zoneOverrideCol
7579		self._CollectedClass = ZoneOverride
7580
7581	@property
7582	def ZoneOverrideColList(self) -> tuple[ZoneOverride]:
7583		return tuple([ZoneOverride(zoneOverrideCol) for zoneOverrideCol in self._Entity])
7584
7585	def Get(self, zoneNumber: int) -> ZoneOverride:
7586		return ZoneOverride(self._Entity.Get(zoneNumber))
7587
7588	def __getitem__(self, index: int):
7589		return self.ZoneOverrideColList[index]
7590
7591	def __iter__(self):
7592		yield from self.ZoneOverrideColList
7593
7594	def __len__(self):
7595		return len(self.ZoneOverrideColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

ZoneOverrideCol(zoneOverrideCol: HyperX.Scripting.ZoneOverrideCol)
7577	def __init__(self, zoneOverrideCol: _api.ZoneOverrideCol):
7578		self._Entity = zoneOverrideCol
7579		self._CollectedClass = ZoneOverride
ZoneOverrideColList: tuple[ZoneOverride]
7581	@property
7582	def ZoneOverrideColList(self) -> tuple[ZoneOverride]:
7583		return tuple([ZoneOverride(zoneOverrideCol) for zoneOverrideCol in self._Entity])
def Get(self, zoneNumber: int) -> ZoneOverride:
7585	def Get(self, zoneNumber: int) -> ZoneOverride:
7586		return ZoneOverride(self._Entity.Get(zoneNumber))
class DesignVariable(IdEntity):
7598class DesignVariable(IdEntity):
7599	'''
7600	Holds design variable data.
7601            Min, max, steps, materials.
7602	'''
7603	def __init__(self, designVariable: _api.DesignVariable):
7604		self._Entity = designVariable
7605
7606	@property
7607	def VariableParameter(self) -> types.VariableParameter:
7608		return types.VariableParameter[self._Entity.VariableParameter.ToString()]
7609
7610	@property
7611	def AllowMaterials(self) -> bool:
7612		return self._Entity.AllowMaterials
7613
7614	@property
7615	def Max(self) -> float:
7616		return self._Entity.Max
7617
7618	@property
7619	def Min(self) -> float:
7620		return self._Entity.Min
7621
7622	@property
7623	def Name(self) -> str:
7624		return self._Entity.Name
7625
7626	@property
7627	def StepSize(self) -> float:
7628		return self._Entity.StepSize
7629
7630	@property
7631	def UseAnalysis(self) -> bool:
7632		return self._Entity.UseAnalysis
7633
7634	@property
7635	def AnalysisMaterial(self) -> str:
7636		return self._Entity.AnalysisMaterial
7637
7638	@property
7639	def AnalysisMaterialType(self) -> types.MaterialType:
7640		return types.MaterialType[self._Entity.AnalysisMaterialType.ToString()]
7641
7642	@property
7643	def SizingMaterialType(self) -> types.MaterialType:
7644		return types.MaterialType[self._Entity.SizingMaterialType.ToString()]
7645
7646	@property
7647	def AnalysisValue(self) -> float:
7648		return self._Entity.AnalysisValue
7649
7650	@property
7651	def Overrides(self) -> ZoneOverrideCol:
7652		result = self._Entity.Overrides
7653		return ZoneOverrideCol(result) if result is not None else None
7654
7655	@Max.setter
7656	def Max(self, value: float) -> None:
7657		self._Entity.Max = value
7658
7659	@Min.setter
7660	def Min(self, value: float) -> None:
7661		self._Entity.Min = value
7662
7663	@StepSize.setter
7664	def StepSize(self, value: float) -> None:
7665		self._Entity.StepSize = value
7666
7667	@UseAnalysis.setter
7668	def UseAnalysis(self, value: bool) -> None:
7669		self._Entity.UseAnalysis = value
7670
7671	@AnalysisMaterial.setter
7672	def AnalysisMaterial(self, value: str) -> None:
7673		self._Entity.AnalysisMaterial = value
7674
7675	@AnalysisValue.setter
7676	def AnalysisValue(self, value: float) -> None:
7677		self._Entity.AnalysisValue = value
7678
7679	@overload
7680	def AddMaterials(self, materialIds: set[int]) -> None: ...
7681
7682	@overload
7683	def AddMaterials(self, materialNames: set[str]) -> None: ...
7684
7685	def GetSizingMaterials(self) -> list[int]:
7686		'''
7687		Get a list of materials used for sizing, if they exist.
7688		'''
7689		return [int32 for int32 in self._Entity.GetSizingMaterials()]
7690
7691	def RemoveSizingMaterials(self, materialIds: tuple[int] = None) -> None:
7692		materialIdsList = MakeCSharpIntList(materialIds)
7693		materialIdsEnumerable = IEnumerable(materialIdsList)
7694		return self._Entity.RemoveSizingMaterials(materialIds if materialIds is None else materialIdsEnumerable)
7695
7696	def GetAnalysisMaterial(self) -> int:
7697		'''
7698		Get the material used for analysis, if it exists.
7699		'''
7700		return self._Entity.GetAnalysisMaterial()
7701
7702	def RemoveAnalysisMaterial(self) -> None:
7703		'''
7704		Remove the analysis material assigned to this variable.
7705		'''
7706		return self._Entity.RemoveAnalysisMaterial()
7707
7708	def AddMaterials(self, item1 = None) -> None:
7709		if isinstance(item1, set) and item1 and isinstance(list(item1)[0], int):
7710			materialIdsSet = HashSet[int]()
7711			if item1 is not None:
7712				for thing in item1:
7713					if thing is not None:
7714						materialIdsSet.Add(thing)
7715			return self._Entity.AddMaterials(materialIdsSet)
7716
7717		if isinstance(item1, set) and item1 and isinstance(list(item1)[0], str):
7718			materialNamesSet = HashSet[str]()
7719			if item1 is not None:
7720				for thing in item1:
7721					if thing is not None:
7722						materialNamesSet.Add(thing)
7723			return self._Entity.AddMaterials(materialNamesSet)
7724
7725		return self._Entity.AddMaterials(item1)

Holds design variable data. Min, max, steps, materials.

DesignVariable(designVariable: HyperX.Scripting.DesignVariable)
7603	def __init__(self, designVariable: _api.DesignVariable):
7604		self._Entity = designVariable
VariableParameter: hyperx.api.types.VariableParameter
7606	@property
7607	def VariableParameter(self) -> types.VariableParameter:
7608		return types.VariableParameter[self._Entity.VariableParameter.ToString()]
AllowMaterials: bool
7610	@property
7611	def AllowMaterials(self) -> bool:
7612		return self._Entity.AllowMaterials
Max: float
7614	@property
7615	def Max(self) -> float:
7616		return self._Entity.Max
Min: float
7618	@property
7619	def Min(self) -> float:
7620		return self._Entity.Min
Name: str
7622	@property
7623	def Name(self) -> str:
7624		return self._Entity.Name
StepSize: float
7626	@property
7627	def StepSize(self) -> float:
7628		return self._Entity.StepSize
UseAnalysis: bool
7630	@property
7631	def UseAnalysis(self) -> bool:
7632		return self._Entity.UseAnalysis
AnalysisMaterial: str
7634	@property
7635	def AnalysisMaterial(self) -> str:
7636		return self._Entity.AnalysisMaterial
AnalysisMaterialType: hyperx.api.types.MaterialType
7638	@property
7639	def AnalysisMaterialType(self) -> types.MaterialType:
7640		return types.MaterialType[self._Entity.AnalysisMaterialType.ToString()]
SizingMaterialType: hyperx.api.types.MaterialType
7642	@property
7643	def SizingMaterialType(self) -> types.MaterialType:
7644		return types.MaterialType[self._Entity.SizingMaterialType.ToString()]
AnalysisValue: float
7646	@property
7647	def AnalysisValue(self) -> float:
7648		return self._Entity.AnalysisValue
Overrides: ZoneOverrideCol
7650	@property
7651	def Overrides(self) -> ZoneOverrideCol:
7652		result = self._Entity.Overrides
7653		return ZoneOverrideCol(result) if result is not None else None
def AddMaterials(self, item1=None) -> None:
7708	def AddMaterials(self, item1 = None) -> None:
7709		if isinstance(item1, set) and item1 and isinstance(list(item1)[0], int):
7710			materialIdsSet = HashSet[int]()
7711			if item1 is not None:
7712				for thing in item1:
7713					if thing is not None:
7714						materialIdsSet.Add(thing)
7715			return self._Entity.AddMaterials(materialIdsSet)
7716
7717		if isinstance(item1, set) and item1 and isinstance(list(item1)[0], str):
7718			materialNamesSet = HashSet[str]()
7719			if item1 is not None:
7720				for thing in item1:
7721					if thing is not None:
7722						materialNamesSet.Add(thing)
7723			return self._Entity.AddMaterials(materialNamesSet)
7724
7725		return self._Entity.AddMaterials(item1)
def GetSizingMaterials(self) -> list[int]:
7685	def GetSizingMaterials(self) -> list[int]:
7686		'''
7687		Get a list of materials used for sizing, if they exist.
7688		'''
7689		return [int32 for int32 in self._Entity.GetSizingMaterials()]

Get a list of materials used for sizing, if they exist.

def RemoveSizingMaterials(self, materialIds: tuple[int] = None) -> None:
7691	def RemoveSizingMaterials(self, materialIds: tuple[int] = None) -> None:
7692		materialIdsList = MakeCSharpIntList(materialIds)
7693		materialIdsEnumerable = IEnumerable(materialIdsList)
7694		return self._Entity.RemoveSizingMaterials(materialIds if materialIds is None else materialIdsEnumerable)
def GetAnalysisMaterial(self) -> int:
7696	def GetAnalysisMaterial(self) -> int:
7697		'''
7698		Get the material used for analysis, if it exists.
7699		'''
7700		return self._Entity.GetAnalysisMaterial()

Get the material used for analysis, if it exists.

def RemoveAnalysisMaterial(self) -> None:
7702	def RemoveAnalysisMaterial(self) -> None:
7703		'''
7704		Remove the analysis material assigned to this variable.
7705		'''
7706		return self._Entity.RemoveAnalysisMaterial()

Remove the analysis material assigned to this variable.

Inherited Members
IdEntity
Id
class ToolingConstraintCol(hyperx.api.IdNameEntityCol[hyperx.api.ToolingConstraint]):
7728class ToolingConstraintCol(IdNameEntityCol[ToolingConstraint]):
7729	def __init__(self, toolingConstraintCol: _api.ToolingConstraintCol):
7730		self._Entity = toolingConstraintCol
7731		self._CollectedClass = ToolingConstraint
7732
7733	@property
7734	def ToolingConstraintColList(self) -> tuple[ToolingConstraint]:
7735		return tuple([ToolingConstraint(toolingConstraintCol) for toolingConstraintCol in self._Entity])
7736
7737	@overload
7738	def Get(self, name: str) -> ToolingConstraint: ...
7739
7740	@overload
7741	def Get(self, id: int) -> ToolingConstraint: ...
7742
7743	def Get(self, item1 = None) -> ToolingConstraint:
7744		if isinstance(item1, str):
7745			return ToolingConstraint(super().Get(item1))
7746
7747		if isinstance(item1, int):
7748			return ToolingConstraint(super().Get(item1))
7749
7750		return ToolingConstraint(self._Entity.Get(item1))
7751
7752	def __getitem__(self, index: int):
7753		return self.ToolingConstraintColList[index]
7754
7755	def __iter__(self):
7756		yield from self.ToolingConstraintColList
7757
7758	def __len__(self):
7759		return len(self.ToolingConstraintColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

ToolingConstraintCol(toolingConstraintCol: HyperX.Scripting.ToolingConstraintCol)
7729	def __init__(self, toolingConstraintCol: _api.ToolingConstraintCol):
7730		self._Entity = toolingConstraintCol
7731		self._CollectedClass = ToolingConstraint
ToolingConstraintColList: tuple[ToolingConstraint]
7733	@property
7734	def ToolingConstraintColList(self) -> tuple[ToolingConstraint]:
7735		return tuple([ToolingConstraint(toolingConstraintCol) for toolingConstraintCol in self._Entity])
def Get(self, item1=None) -> ToolingConstraint:
7743	def Get(self, item1 = None) -> ToolingConstraint:
7744		if isinstance(item1, str):
7745			return ToolingConstraint(super().Get(item1))
7746
7747		if isinstance(item1, int):
7748			return ToolingConstraint(super().Get(item1))
7749
7750		return ToolingConstraint(self._Entity.Get(item1))
class DesignVariableCol(hyperx.api.IdEntityCol[hyperx.api.DesignVariable]):
7762class DesignVariableCol(IdEntityCol[DesignVariable]):
7763	def __init__(self, designVariableCol: _api.DesignVariableCol):
7764		self._Entity = designVariableCol
7765		self._CollectedClass = DesignVariable
7766
7767	@property
7768	def DesignVariableColList(self) -> tuple[DesignVariable]:
7769		return tuple([DesignVariable(designVariableCol) for designVariableCol in self._Entity])
7770
7771	@overload
7772	def Get(self, parameterId: types.VariableParameter) -> DesignVariable: ...
7773
7774	@overload
7775	def Get(self, id: int) -> DesignVariable: ...
7776
7777	def Get(self, item1 = None) -> DesignVariable:
7778		if isinstance(item1, types.VariableParameter):
7779			return DesignVariable(self._Entity.Get(_types.VariableParameter(item1.value)))
7780
7781		if isinstance(item1, int):
7782			return DesignVariable(super().Get(item1))
7783
7784		return DesignVariable(self._Entity.Get(_types.VariableParameter(item1.value)))
7785
7786	def __getitem__(self, index: int):
7787		return self.DesignVariableColList[index]
7788
7789	def __iter__(self):
7790		yield from self.DesignVariableColList
7791
7792	def __len__(self):
7793		return len(self.DesignVariableColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

DesignVariableCol(designVariableCol: HyperX.Scripting.DesignVariableCol)
7763	def __init__(self, designVariableCol: _api.DesignVariableCol):
7764		self._Entity = designVariableCol
7765		self._CollectedClass = DesignVariable
DesignVariableColList: tuple[DesignVariable]
7767	@property
7768	def DesignVariableColList(self) -> tuple[DesignVariable]:
7769		return tuple([DesignVariable(designVariableCol) for designVariableCol in self._Entity])
def Get(self, item1=None) -> DesignVariable:
7777	def Get(self, item1 = None) -> DesignVariable:
7778		if isinstance(item1, types.VariableParameter):
7779			return DesignVariable(self._Entity.Get(_types.VariableParameter(item1.value)))
7780
7781		if isinstance(item1, int):
7782			return DesignVariable(super().Get(item1))
7783
7784		return DesignVariable(self._Entity.Get(_types.VariableParameter(item1.value)))
class ZoneDesignProperty(DesignProperty):
7796class ZoneDesignProperty(DesignProperty):
7797	def __init__(self, zoneDesignProperty: _api.ZoneDesignProperty):
7798		self._Entity = zoneDesignProperty
7799
7800	@property
7801	def FamilyId(self) -> types.BeamPanelFamily:
7802		return types.BeamPanelFamily[self._Entity.FamilyId.ToString()]
7803
7804	@property
7805	def ConceptId(self) -> int:
7806		return self._Entity.ConceptId
7807
7808	@property
7809	def FamilyConceptUID(self) -> types.FamilyConceptUID:
7810		return types.FamilyConceptUID[self._Entity.FamilyConceptUID.ToString()]
7811
7812	@property
7813	def ToolingConstraints(self) -> ToolingConstraintCol:
7814		result = self._Entity.ToolingConstraints
7815		return ToolingConstraintCol(result) if result is not None else None
7816
7817	@property
7818	def DesignVariables(self) -> DesignVariableCol:
7819		result = self._Entity.DesignVariables
7820		return DesignVariableCol(result) if result is not None else None

Represents an entity with an ID and Name.

ZoneDesignProperty(zoneDesignProperty: HyperX.Scripting.ZoneDesignProperty)
7797	def __init__(self, zoneDesignProperty: _api.ZoneDesignProperty):
7798		self._Entity = zoneDesignProperty
FamilyId: hyperx.api.types.BeamPanelFamily
7800	@property
7801	def FamilyId(self) -> types.BeamPanelFamily:
7802		return types.BeamPanelFamily[self._Entity.FamilyId.ToString()]
ConceptId: int
7804	@property
7805	def ConceptId(self) -> int:
7806		return self._Entity.ConceptId
FamilyConceptUID: hyperx.api.types.FamilyConceptUID
7808	@property
7809	def FamilyConceptUID(self) -> types.FamilyConceptUID:
7810		return types.FamilyConceptUID[self._Entity.FamilyConceptUID.ToString()]
ToolingConstraints: ToolingConstraintCol
7812	@property
7813	def ToolingConstraints(self) -> ToolingConstraintCol:
7814		result = self._Entity.ToolingConstraints
7815		return ToolingConstraintCol(result) if result is not None else None
DesignVariables: DesignVariableCol
7817	@property
7818	def DesignVariables(self) -> DesignVariableCol:
7819		result = self._Entity.DesignVariables
7820		return DesignVariableCol(result) if result is not None else None
class BulkUpdaterBase(abc.ABC):
7823class BulkUpdaterBase(ABC):
7824	def __init__(self, bulkUpdaterBase: _api.BulkUpdaterBase):
7825		self._Entity = bulkUpdaterBase
7826
7827	def Update(self, func: Action) -> None:
7828		entityType = self._Entity.GetType().BaseType.GenericTypeArguments[0]
7829		funcAction = Action[entityType](func)
7830		return self._Entity.Update(funcAction)
BulkUpdaterBase(bulkUpdaterBase: HyperX.Scripting.BulkUpdaterBase[])
7824	def __init__(self, bulkUpdaterBase: _api.BulkUpdaterBase):
7825		self._Entity = bulkUpdaterBase
def Update(self, func: System.Action) -> None:
7827	def Update(self, func: Action) -> None:
7828		entityType = self._Entity.GetType().BaseType.GenericTypeArguments[0]
7829		funcAction = Action[entityType](func)
7830		return self._Entity.Update(funcAction)
class LoadPropertyUserRowBulkUpdater(BulkUpdaterBase):
7833class LoadPropertyUserRowBulkUpdater(BulkUpdaterBase):
7834	def __init__(self, loadPropertyUserRowBulkUpdater: _api.LoadPropertyUserRowBulkUpdater):
7835		self._Entity = loadPropertyUserRowBulkUpdater
LoadPropertyUserRowBulkUpdater( loadPropertyUserRowBulkUpdater: HyperX.Scripting.LoadPropertyUserRowBulkUpdater[])
7834	def __init__(self, loadPropertyUserRowBulkUpdater: _api.LoadPropertyUserRowBulkUpdater):
7835		self._Entity = loadPropertyUserRowBulkUpdater
Inherited Members
BulkUpdaterBase
Update
class LoadPropertyUserRow(IdNameEntity):
7838class LoadPropertyUserRow(IdNameEntity):
7839	def __init__(self, loadPropertyUserRow: _api.LoadPropertyUserRow):
7840		self._Entity = loadPropertyUserRow
7841
7842	@property
7843	def LoadScenarioId(self) -> int:
7844		return self._Entity.LoadScenarioId
7845
7846	@property
7847	def LoadPropertyId(self) -> int:
7848		return self._Entity.LoadPropertyId
7849
7850	@property
7851	def Type(self) -> types.LoadSetType:
7852		return types.LoadSetType[self._Entity.Type.ToString()]
7853
7854	@property
7855	def ReferenceTemperature(self) -> float:
7856		return self._Entity.ReferenceTemperature
7857
7858	@property
7859	def PressureOrTemperature(self) -> float:
7860		return self._Entity.PressureOrTemperature
7861
7862	@property
7863	def LimitFactor(self) -> float:
7864		return self._Entity.LimitFactor
7865
7866	@property
7867	def UltimateFactor(self) -> float:
7868		return self._Entity.UltimateFactor
7869
7870	@ReferenceTemperature.setter
7871	def ReferenceTemperature(self, value: float) -> None:
7872		self._Entity.ReferenceTemperature = value
7873
7874	@PressureOrTemperature.setter
7875	def PressureOrTemperature(self, value: float) -> None:
7876		self._Entity.PressureOrTemperature = value
7877
7878	@LimitFactor.setter
7879	def LimitFactor(self, value: float) -> None:
7880		self._Entity.LimitFactor = value
7881
7882	@UltimateFactor.setter
7883	def UltimateFactor(self, value: float) -> None:
7884		self._Entity.UltimateFactor = value

Represents an entity with an ID and Name.

LoadPropertyUserRow(loadPropertyUserRow: HyperX.Scripting.LoadPropertyUserRow)
7839	def __init__(self, loadPropertyUserRow: _api.LoadPropertyUserRow):
7840		self._Entity = loadPropertyUserRow
LoadScenarioId: int
7842	@property
7843	def LoadScenarioId(self) -> int:
7844		return self._Entity.LoadScenarioId
LoadPropertyId: int
7846	@property
7847	def LoadPropertyId(self) -> int:
7848		return self._Entity.LoadPropertyId
Type: hyperx.api.types.LoadSetType
7850	@property
7851	def Type(self) -> types.LoadSetType:
7852		return types.LoadSetType[self._Entity.Type.ToString()]
ReferenceTemperature: float
7854	@property
7855	def ReferenceTemperature(self) -> float:
7856		return self._Entity.ReferenceTemperature
PressureOrTemperature: float
7858	@property
7859	def PressureOrTemperature(self) -> float:
7860		return self._Entity.PressureOrTemperature
LimitFactor: float
7862	@property
7863	def LimitFactor(self) -> float:
7864		return self._Entity.LimitFactor
UltimateFactor: float
7866	@property
7867	def UltimateFactor(self) -> float:
7868		return self._Entity.UltimateFactor
Inherited Members
IdNameEntity
Name
IdEntity
Id
class LoadPropertyUserBeamRow(LoadPropertyUserRow):
7887class LoadPropertyUserBeamRow(LoadPropertyUserRow):
7888	def __init__(self, loadPropertyUserBeamRow: _api.LoadPropertyUserBeamRow):
7889		self._Entity = loadPropertyUserBeamRow
7890
7891	@property
7892	def M1A(self) -> float:
7893		return self._Entity.M1A
7894
7895	@property
7896	def M2A(self) -> float:
7897		return self._Entity.M2A
7898
7899	@property
7900	def M1B(self) -> float:
7901		return self._Entity.M1B
7902
7903	@property
7904	def M2B(self) -> float:
7905		return self._Entity.M2B
7906
7907	@property
7908	def V1(self) -> float:
7909		return self._Entity.V1
7910
7911	@property
7912	def V2(self) -> float:
7913		return self._Entity.V2
7914
7915	@property
7916	def Axial(self) -> float:
7917		return self._Entity.Axial
7918
7919	@property
7920	def Torque(self) -> float:
7921		return self._Entity.Torque
7922
7923	@M1A.setter
7924	def M1A(self, value: float) -> None:
7925		self._Entity.M1A = value
7926
7927	@M2A.setter
7928	def M2A(self, value: float) -> None:
7929		self._Entity.M2A = value
7930
7931	@M1B.setter
7932	def M1B(self, value: float) -> None:
7933		self._Entity.M1B = value
7934
7935	@M2B.setter
7936	def M2B(self, value: float) -> None:
7937		self._Entity.M2B = value
7938
7939	@V1.setter
7940	def V1(self, value: float) -> None:
7941		self._Entity.V1 = value
7942
7943	@V2.setter
7944	def V2(self, value: float) -> None:
7945		self._Entity.V2 = value
7946
7947	@Axial.setter
7948	def Axial(self, value: float) -> None:
7949		self._Entity.Axial = value
7950
7951	@Torque.setter
7952	def Torque(self, value: float) -> None:
7953		self._Entity.Torque = value

Represents an entity with an ID and Name.

LoadPropertyUserBeamRow(loadPropertyUserBeamRow: HyperX.Scripting.LoadPropertyUserBeamRow)
7888	def __init__(self, loadPropertyUserBeamRow: _api.LoadPropertyUserBeamRow):
7889		self._Entity = loadPropertyUserBeamRow
M1A: float
7891	@property
7892	def M1A(self) -> float:
7893		return self._Entity.M1A
M2A: float
7895	@property
7896	def M2A(self) -> float:
7897		return self._Entity.M2A
M1B: float
7899	@property
7900	def M1B(self) -> float:
7901		return self._Entity.M1B
M2B: float
7903	@property
7904	def M2B(self) -> float:
7905		return self._Entity.M2B
V1: float
7907	@property
7908	def V1(self) -> float:
7909		return self._Entity.V1
V2: float
7911	@property
7912	def V2(self) -> float:
7913		return self._Entity.V2
Axial: float
7915	@property
7916	def Axial(self) -> float:
7917		return self._Entity.Axial
Torque: float
7919	@property
7920	def Torque(self) -> float:
7921		return self._Entity.Torque
class LoadPropertyUserFeaBeamRow(LoadPropertyUserBeamRow):
7956class LoadPropertyUserFeaBeamRow(LoadPropertyUserBeamRow):
7957	def __init__(self, loadPropertyUserFeaBeamRow: _api.LoadPropertyUserFeaBeamRow):
7958		self._Entity = loadPropertyUserFeaBeamRow
7959
7960	def SetName(self, name: str) -> None:
7961		return self._Entity.SetName(name)

Represents an entity with an ID and Name.

LoadPropertyUserFeaBeamRow( loadPropertyUserFeaBeamRow: HyperX.Scripting.LoadPropertyUserFeaBeamRow)
7957	def __init__(self, loadPropertyUserFeaBeamRow: _api.LoadPropertyUserFeaBeamRow):
7958		self._Entity = loadPropertyUserFeaBeamRow
def SetName(self, name: str) -> None:
7960	def SetName(self, name: str) -> None:
7961		return self._Entity.SetName(name)
class LoadPropertyUserFeaBeamRowBulkUpdater(LoadPropertyUserRowBulkUpdater):
7964class LoadPropertyUserFeaBeamRowBulkUpdater(LoadPropertyUserRowBulkUpdater):
7965	def __init__(self, loadPropertyUserFeaBeamRowBulkUpdater: _api.LoadPropertyUserFeaBeamRowBulkUpdater):
7966		self._Entity = loadPropertyUserFeaBeamRowBulkUpdater
7967
7968	def GetBulkUpdater(application: Application, items: list[LoadPropertyUserFeaBeamRow]) -> LoadPropertyUserFeaBeamRowBulkUpdater:
7969		itemsList = List[_api.LoadPropertyUserFeaBeamRow]()
7970		if items is not None:
7971			for thing in items:
7972				if thing is not None:
7973					itemsList.Add(thing._Entity)
7974		return LoadPropertyUserFeaBeamRowBulkUpdater(_api.LoadPropertyUserFeaBeamRowBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
LoadPropertyUserFeaBeamRowBulkUpdater( loadPropertyUserFeaBeamRowBulkUpdater: HyperX.Scripting.LoadPropertyUserFeaBeamRowBulkUpdater)
7965	def __init__(self, loadPropertyUserFeaBeamRowBulkUpdater: _api.LoadPropertyUserFeaBeamRowBulkUpdater):
7966		self._Entity = loadPropertyUserFeaBeamRowBulkUpdater
def GetBulkUpdater( application: Application, items: list[LoadPropertyUserFeaBeamRow]) -> LoadPropertyUserFeaBeamRowBulkUpdater:
7968	def GetBulkUpdater(application: Application, items: list[LoadPropertyUserFeaBeamRow]) -> LoadPropertyUserFeaBeamRowBulkUpdater:
7969		itemsList = List[_api.LoadPropertyUserFeaBeamRow]()
7970		if items is not None:
7971			for thing in items:
7972				if thing is not None:
7973					itemsList.Add(thing._Entity)
7974		return LoadPropertyUserFeaBeamRowBulkUpdater(_api.LoadPropertyUserFeaBeamRowBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
Inherited Members
BulkUpdaterBase
Update
class LoadPropertyUserPanelJointRow(LoadPropertyUserRow):
7977class LoadPropertyUserPanelJointRow(LoadPropertyUserRow):
7978	def __init__(self, loadPropertyUserPanelJointRow: _api.LoadPropertyUserPanelJointRow):
7979		self._Entity = loadPropertyUserPanelJointRow
7980
7981	@property
7982	def Nx(self) -> float:
7983		return self._Entity.Nx
7984
7985	@property
7986	def Ny(self) -> float:
7987		return self._Entity.Ny
7988
7989	@property
7990	def Nxy(self) -> float:
7991		return self._Entity.Nxy
7992
7993	@property
7994	def Mx(self) -> float:
7995		return self._Entity.Mx
7996
7997	@property
7998	def My(self) -> float:
7999		return self._Entity.My
8000
8001	@property
8002	def Mxy(self) -> float:
8003		return self._Entity.Mxy
8004
8005	@property
8006	def Qx(self) -> float:
8007		return self._Entity.Qx
8008
8009	@property
8010	def Qy(self) -> float:
8011		return self._Entity.Qy
8012
8013	@Nx.setter
8014	def Nx(self, value: float) -> None:
8015		self._Entity.Nx = value
8016
8017	@Ny.setter
8018	def Ny(self, value: float) -> None:
8019		self._Entity.Ny = value
8020
8021	@Nxy.setter
8022	def Nxy(self, value: float) -> None:
8023		self._Entity.Nxy = value
8024
8025	@Mx.setter
8026	def Mx(self, value: float) -> None:
8027		self._Entity.Mx = value
8028
8029	@My.setter
8030	def My(self, value: float) -> None:
8031		self._Entity.My = value
8032
8033	@Mxy.setter
8034	def Mxy(self, value: float) -> None:
8035		self._Entity.Mxy = value
8036
8037	@Qx.setter
8038	def Qx(self, value: float) -> None:
8039		self._Entity.Qx = value
8040
8041	@Qy.setter
8042	def Qy(self, value: float) -> None:
8043		self._Entity.Qy = value

Represents an entity with an ID and Name.

LoadPropertyUserPanelJointRow( loadPropertyUserPanelJointRow: HyperX.Scripting.LoadPropertyUserPanelJointRow)
7978	def __init__(self, loadPropertyUserPanelJointRow: _api.LoadPropertyUserPanelJointRow):
7979		self._Entity = loadPropertyUserPanelJointRow
Nx: float
7981	@property
7982	def Nx(self) -> float:
7983		return self._Entity.Nx
Ny: float
7985	@property
7986	def Ny(self) -> float:
7987		return self._Entity.Ny
Nxy: float
7989	@property
7990	def Nxy(self) -> float:
7991		return self._Entity.Nxy
Mx: float
7993	@property
7994	def Mx(self) -> float:
7995		return self._Entity.Mx
My: float
7997	@property
7998	def My(self) -> float:
7999		return self._Entity.My
Mxy: float
8001	@property
8002	def Mxy(self) -> float:
8003		return self._Entity.Mxy
Qx: float
8005	@property
8006	def Qx(self) -> float:
8007		return self._Entity.Qx
Qy: float
8009	@property
8010	def Qy(self) -> float:
8011		return self._Entity.Qy
class LoadPropertyUserFeaJointRow(LoadPropertyUserPanelJointRow):
8046class LoadPropertyUserFeaJointRow(LoadPropertyUserPanelJointRow):
8047	def __init__(self, loadPropertyUserFeaJointRow: _api.LoadPropertyUserFeaJointRow):
8048		self._Entity = loadPropertyUserFeaJointRow
8049
8050	def SetName(self, name: str) -> None:
8051		return self._Entity.SetName(name)

Represents an entity with an ID and Name.

LoadPropertyUserFeaJointRow( loadPropertyUserFeaJointRow: HyperX.Scripting.LoadPropertyUserFeaJointRow)
8047	def __init__(self, loadPropertyUserFeaJointRow: _api.LoadPropertyUserFeaJointRow):
8048		self._Entity = loadPropertyUserFeaJointRow
def SetName(self, name: str) -> None:
8050	def SetName(self, name: str) -> None:
8051		return self._Entity.SetName(name)
class LoadPropertyUserFeaJointRowBulkUpdater(LoadPropertyUserRowBulkUpdater):
8054class LoadPropertyUserFeaJointRowBulkUpdater(LoadPropertyUserRowBulkUpdater):
8055	def __init__(self, loadPropertyUserFeaJointRowBulkUpdater: _api.LoadPropertyUserFeaJointRowBulkUpdater):
8056		self._Entity = loadPropertyUserFeaJointRowBulkUpdater
8057
8058	def GetBulkUpdater(application: Application, items: list[LoadPropertyUserFeaJointRow]) -> LoadPropertyUserFeaJointRowBulkUpdater:
8059		itemsList = List[_api.LoadPropertyUserFeaJointRow]()
8060		if items is not None:
8061			for thing in items:
8062				if thing is not None:
8063					itemsList.Add(thing._Entity)
8064		return LoadPropertyUserFeaJointRowBulkUpdater(_api.LoadPropertyUserFeaJointRowBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
LoadPropertyUserFeaJointRowBulkUpdater( loadPropertyUserFeaJointRowBulkUpdater: HyperX.Scripting.LoadPropertyUserFeaJointRowBulkUpdater)
8055	def __init__(self, loadPropertyUserFeaJointRowBulkUpdater: _api.LoadPropertyUserFeaJointRowBulkUpdater):
8056		self._Entity = loadPropertyUserFeaJointRowBulkUpdater
def GetBulkUpdater( application: Application, items: list[LoadPropertyUserFeaJointRow]) -> LoadPropertyUserFeaJointRowBulkUpdater:
8058	def GetBulkUpdater(application: Application, items: list[LoadPropertyUserFeaJointRow]) -> LoadPropertyUserFeaJointRowBulkUpdater:
8059		itemsList = List[_api.LoadPropertyUserFeaJointRow]()
8060		if items is not None:
8061			for thing in items:
8062				if thing is not None:
8063					itemsList.Add(thing._Entity)
8064		return LoadPropertyUserFeaJointRowBulkUpdater(_api.LoadPropertyUserFeaJointRowBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
Inherited Members
BulkUpdaterBase
Update
class LoadPropertyUserFeaPanelRow(LoadPropertyUserPanelJointRow):
8067class LoadPropertyUserFeaPanelRow(LoadPropertyUserPanelJointRow):
8068	def __init__(self, loadPropertyUserFeaPanelRow: _api.LoadPropertyUserFeaPanelRow):
8069		self._Entity = loadPropertyUserFeaPanelRow
8070
8071	def SetName(self, name: str) -> None:
8072		return self._Entity.SetName(name)

Represents an entity with an ID and Name.

LoadPropertyUserFeaPanelRow( loadPropertyUserFeaPanelRow: HyperX.Scripting.LoadPropertyUserFeaPanelRow)
8068	def __init__(self, loadPropertyUserFeaPanelRow: _api.LoadPropertyUserFeaPanelRow):
8069		self._Entity = loadPropertyUserFeaPanelRow
def SetName(self, name: str) -> None:
8071	def SetName(self, name: str) -> None:
8072		return self._Entity.SetName(name)
class LoadPropertyUserFeaPanelRowBulkUpdater(LoadPropertyUserRowBulkUpdater):
8075class LoadPropertyUserFeaPanelRowBulkUpdater(LoadPropertyUserRowBulkUpdater):
8076	def __init__(self, loadPropertyUserFeaPanelRowBulkUpdater: _api.LoadPropertyUserFeaPanelRowBulkUpdater):
8077		self._Entity = loadPropertyUserFeaPanelRowBulkUpdater
8078
8079	def GetBulkUpdater(application: Application, items: list[LoadPropertyUserFeaPanelRow]) -> LoadPropertyUserFeaPanelRowBulkUpdater:
8080		itemsList = List[_api.LoadPropertyUserFeaPanelRow]()
8081		if items is not None:
8082			for thing in items:
8083				if thing is not None:
8084					itemsList.Add(thing._Entity)
8085		return LoadPropertyUserFeaPanelRowBulkUpdater(_api.LoadPropertyUserFeaPanelRowBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
LoadPropertyUserFeaPanelRowBulkUpdater( loadPropertyUserFeaPanelRowBulkUpdater: HyperX.Scripting.LoadPropertyUserFeaPanelRowBulkUpdater)
8076	def __init__(self, loadPropertyUserFeaPanelRowBulkUpdater: _api.LoadPropertyUserFeaPanelRowBulkUpdater):
8077		self._Entity = loadPropertyUserFeaPanelRowBulkUpdater
def GetBulkUpdater( application: Application, items: list[LoadPropertyUserFeaPanelRow]) -> LoadPropertyUserFeaPanelRowBulkUpdater:
8079	def GetBulkUpdater(application: Application, items: list[LoadPropertyUserFeaPanelRow]) -> LoadPropertyUserFeaPanelRowBulkUpdater:
8080		itemsList = List[_api.LoadPropertyUserFeaPanelRow]()
8081		if items is not None:
8082			for thing in items:
8083				if thing is not None:
8084					itemsList.Add(thing._Entity)
8085		return LoadPropertyUserFeaPanelRowBulkUpdater(_api.LoadPropertyUserFeaPanelRowBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
Inherited Members
BulkUpdaterBase
Update
class LoadPropertyUserGeneralBeamRow(LoadPropertyUserBeamRow):
8088class LoadPropertyUserGeneralBeamRow(LoadPropertyUserBeamRow):
8089	def __init__(self, loadPropertyUserGeneralBeamRow: _api.LoadPropertyUserGeneralBeamRow):
8090		self._Entity = loadPropertyUserGeneralBeamRow
8091
8092	@property
8093	def M1A(self) -> float:
8094		return self._Entity.M1A
8095
8096	@property
8097	def M2A(self) -> float:
8098		return self._Entity.M2A
8099
8100	@property
8101	def M1B(self) -> float:
8102		return self._Entity.M1B
8103
8104	@property
8105	def M2B(self) -> float:
8106		return self._Entity.M2B
8107
8108	@property
8109	def V1(self) -> float:
8110		return self._Entity.V1
8111
8112	@property
8113	def V2(self) -> float:
8114		return self._Entity.V2
8115
8116	@property
8117	def Axial(self) -> float:
8118		return self._Entity.Axial
8119
8120	@property
8121	def Torque(self) -> float:
8122		return self._Entity.Torque
8123
8124	@property
8125	def M1AType(self) -> types.BoundaryConditionType:
8126		return types.BoundaryConditionType[self._Entity.M1AType.ToString()]
8127
8128	@property
8129	def M2AType(self) -> types.BoundaryConditionType:
8130		return types.BoundaryConditionType[self._Entity.M2AType.ToString()]
8131
8132	@property
8133	def M1BType(self) -> types.BoundaryConditionType:
8134		return types.BoundaryConditionType[self._Entity.M1BType.ToString()]
8135
8136	@property
8137	def M2BType(self) -> types.BoundaryConditionType:
8138		return types.BoundaryConditionType[self._Entity.M2BType.ToString()]
8139
8140	@property
8141	def V1Type(self) -> types.BoundaryConditionType:
8142		return types.BoundaryConditionType[self._Entity.V1Type.ToString()]
8143
8144	@property
8145	def V2Type(self) -> types.BoundaryConditionType:
8146		return types.BoundaryConditionType[self._Entity.V2Type.ToString()]
8147
8148	@property
8149	def AxialType(self) -> types.BoundaryConditionType:
8150		return types.BoundaryConditionType[self._Entity.AxialType.ToString()]
8151
8152	@property
8153	def TorqueType(self) -> types.BoundaryConditionType:
8154		return types.BoundaryConditionType[self._Entity.TorqueType.ToString()]
8155
8156	@M1A.setter
8157	def M1A(self, value: float) -> None:
8158		self._Entity.M1A = value
8159
8160	@M2A.setter
8161	def M2A(self, value: float) -> None:
8162		self._Entity.M2A = value
8163
8164	@M1B.setter
8165	def M1B(self, value: float) -> None:
8166		self._Entity.M1B = value
8167
8168	@M2B.setter
8169	def M2B(self, value: float) -> None:
8170		self._Entity.M2B = value
8171
8172	@V1.setter
8173	def V1(self, value: float) -> None:
8174		self._Entity.V1 = value
8175
8176	@V2.setter
8177	def V2(self, value: float) -> None:
8178		self._Entity.V2 = value
8179
8180	@Axial.setter
8181	def Axial(self, value: float) -> None:
8182		self._Entity.Axial = value
8183
8184	@Torque.setter
8185	def Torque(self, value: float) -> None:
8186		self._Entity.Torque = value

Represents an entity with an ID and Name.

LoadPropertyUserGeneralBeamRow( loadPropertyUserGeneralBeamRow: HyperX.Scripting.LoadPropertyUserGeneralBeamRow)
8089	def __init__(self, loadPropertyUserGeneralBeamRow: _api.LoadPropertyUserGeneralBeamRow):
8090		self._Entity = loadPropertyUserGeneralBeamRow
M1A: float
8092	@property
8093	def M1A(self) -> float:
8094		return self._Entity.M1A
M2A: float
8096	@property
8097	def M2A(self) -> float:
8098		return self._Entity.M2A
M1B: float
8100	@property
8101	def M1B(self) -> float:
8102		return self._Entity.M1B
M2B: float
8104	@property
8105	def M2B(self) -> float:
8106		return self._Entity.M2B
V1: float
8108	@property
8109	def V1(self) -> float:
8110		return self._Entity.V1
V2: float
8112	@property
8113	def V2(self) -> float:
8114		return self._Entity.V2
Axial: float
8116	@property
8117	def Axial(self) -> float:
8118		return self._Entity.Axial
Torque: float
8120	@property
8121	def Torque(self) -> float:
8122		return self._Entity.Torque
8124	@property
8125	def M1AType(self) -> types.BoundaryConditionType:
8126		return types.BoundaryConditionType[self._Entity.M1AType.ToString()]
8128	@property
8129	def M2AType(self) -> types.BoundaryConditionType:
8130		return types.BoundaryConditionType[self._Entity.M2AType.ToString()]
8132	@property
8133	def M1BType(self) -> types.BoundaryConditionType:
8134		return types.BoundaryConditionType[self._Entity.M1BType.ToString()]
8136	@property
8137	def M2BType(self) -> types.BoundaryConditionType:
8138		return types.BoundaryConditionType[self._Entity.M2BType.ToString()]
8140	@property
8141	def V1Type(self) -> types.BoundaryConditionType:
8142		return types.BoundaryConditionType[self._Entity.V1Type.ToString()]
8144	@property
8145	def V2Type(self) -> types.BoundaryConditionType:
8146		return types.BoundaryConditionType[self._Entity.V2Type.ToString()]
8148	@property
8149	def AxialType(self) -> types.BoundaryConditionType:
8150		return types.BoundaryConditionType[self._Entity.AxialType.ToString()]
TorqueType: hyperx.api.types.BoundaryConditionType
8152	@property
8153	def TorqueType(self) -> types.BoundaryConditionType:
8154		return types.BoundaryConditionType[self._Entity.TorqueType.ToString()]
class LoadPropertyUserGeneralBeamRowBulkUpdater(LoadPropertyUserRowBulkUpdater):
8189class LoadPropertyUserGeneralBeamRowBulkUpdater(LoadPropertyUserRowBulkUpdater):
8190	def __init__(self, loadPropertyUserGeneralBeamRowBulkUpdater: _api.LoadPropertyUserGeneralBeamRowBulkUpdater):
8191		self._Entity = loadPropertyUserGeneralBeamRowBulkUpdater
8192
8193	def GetBulkUpdater(application: Application, items: list[LoadPropertyUserGeneralBeamRow]) -> LoadPropertyUserGeneralBeamRowBulkUpdater:
8194		itemsList = List[_api.LoadPropertyUserGeneralBeamRow]()
8195		if items is not None:
8196			for thing in items:
8197				if thing is not None:
8198					itemsList.Add(thing._Entity)
8199		return LoadPropertyUserGeneralBeamRowBulkUpdater(_api.LoadPropertyUserGeneralBeamRowBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
LoadPropertyUserGeneralBeamRowBulkUpdater( loadPropertyUserGeneralBeamRowBulkUpdater: HyperX.Scripting.LoadPropertyUserGeneralBeamRowBulkUpdater)
8190	def __init__(self, loadPropertyUserGeneralBeamRowBulkUpdater: _api.LoadPropertyUserGeneralBeamRowBulkUpdater):
8191		self._Entity = loadPropertyUserGeneralBeamRowBulkUpdater
def GetBulkUpdater( application: Application, items: list[LoadPropertyUserGeneralBeamRow]) -> LoadPropertyUserGeneralBeamRowBulkUpdater:
8193	def GetBulkUpdater(application: Application, items: list[LoadPropertyUserGeneralBeamRow]) -> LoadPropertyUserGeneralBeamRowBulkUpdater:
8194		itemsList = List[_api.LoadPropertyUserGeneralBeamRow]()
8195		if items is not None:
8196			for thing in items:
8197				if thing is not None:
8198					itemsList.Add(thing._Entity)
8199		return LoadPropertyUserGeneralBeamRowBulkUpdater(_api.LoadPropertyUserGeneralBeamRowBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
Inherited Members
BulkUpdaterBase
Update
class LoadPropertyUserGeneralPanelRow(LoadPropertyUserPanelJointRow):
8202class LoadPropertyUserGeneralPanelRow(LoadPropertyUserPanelJointRow):
8203	def __init__(self, loadPropertyUserGeneralPanelRow: _api.LoadPropertyUserGeneralPanelRow):
8204		self._Entity = loadPropertyUserGeneralPanelRow
8205
8206	@property
8207	def Nx(self) -> float:
8208		return self._Entity.Nx
8209
8210	@property
8211	def Ny(self) -> float:
8212		return self._Entity.Ny
8213
8214	@property
8215	def Nxy(self) -> float:
8216		return self._Entity.Nxy
8217
8218	@property
8219	def Mx(self) -> float:
8220		return self._Entity.Mx
8221
8222	@property
8223	def My(self) -> float:
8224		return self._Entity.My
8225
8226	@property
8227	def Mxy(self) -> float:
8228		return self._Entity.Mxy
8229
8230	@property
8231	def Qx(self) -> float:
8232		return self._Entity.Qx
8233
8234	@property
8235	def Qy(self) -> float:
8236		return self._Entity.Qy
8237
8238	@property
8239	def NxType(self) -> types.BoundaryConditionType:
8240		return types.BoundaryConditionType[self._Entity.NxType.ToString()]
8241
8242	@property
8243	def NyType(self) -> types.BoundaryConditionType:
8244		return types.BoundaryConditionType[self._Entity.NyType.ToString()]
8245
8246	@property
8247	def NxyType(self) -> types.BoundaryConditionType:
8248		return types.BoundaryConditionType[self._Entity.NxyType.ToString()]
8249
8250	@property
8251	def MxType(self) -> types.BoundaryConditionType:
8252		return types.BoundaryConditionType[self._Entity.MxType.ToString()]
8253
8254	@property
8255	def MyType(self) -> types.BoundaryConditionType:
8256		return types.BoundaryConditionType[self._Entity.MyType.ToString()]
8257
8258	@property
8259	def MxyType(self) -> types.BoundaryConditionType:
8260		return types.BoundaryConditionType[self._Entity.MxyType.ToString()]
8261
8262	@property
8263	def QxType(self) -> types.BoundaryConditionType:
8264		return types.BoundaryConditionType[self._Entity.QxType.ToString()]
8265
8266	@property
8267	def QyType(self) -> types.BoundaryConditionType:
8268		return types.BoundaryConditionType[self._Entity.QyType.ToString()]
8269
8270	@Nx.setter
8271	def Nx(self, value: float) -> None:
8272		self._Entity.Nx = value
8273
8274	@Ny.setter
8275	def Ny(self, value: float) -> None:
8276		self._Entity.Ny = value
8277
8278	@Nxy.setter
8279	def Nxy(self, value: float) -> None:
8280		self._Entity.Nxy = value
8281
8282	@Mx.setter
8283	def Mx(self, value: float) -> None:
8284		self._Entity.Mx = value
8285
8286	@My.setter
8287	def My(self, value: float) -> None:
8288		self._Entity.My = value
8289
8290	@Mxy.setter
8291	def Mxy(self, value: float) -> None:
8292		self._Entity.Mxy = value
8293
8294	@Qx.setter
8295	def Qx(self, value: float) -> None:
8296		self._Entity.Qx = value
8297
8298	@Qy.setter
8299	def Qy(self, value: float) -> None:
8300		self._Entity.Qy = value

Represents an entity with an ID and Name.

LoadPropertyUserGeneralPanelRow( loadPropertyUserGeneralPanelRow: HyperX.Scripting.LoadPropertyUserGeneralPanelRow)
8203	def __init__(self, loadPropertyUserGeneralPanelRow: _api.LoadPropertyUserGeneralPanelRow):
8204		self._Entity = loadPropertyUserGeneralPanelRow
Nx: float
8206	@property
8207	def Nx(self) -> float:
8208		return self._Entity.Nx
Ny: float
8210	@property
8211	def Ny(self) -> float:
8212		return self._Entity.Ny
Nxy: float
8214	@property
8215	def Nxy(self) -> float:
8216		return self._Entity.Nxy
Mx: float
8218	@property
8219	def Mx(self) -> float:
8220		return self._Entity.Mx
My: float
8222	@property
8223	def My(self) -> float:
8224		return self._Entity.My
Mxy: float
8226	@property
8227	def Mxy(self) -> float:
8228		return self._Entity.Mxy
Qx: float
8230	@property
8231	def Qx(self) -> float:
8232		return self._Entity.Qx
Qy: float
8234	@property
8235	def Qy(self) -> float:
8236		return self._Entity.Qy
8238	@property
8239	def NxType(self) -> types.BoundaryConditionType:
8240		return types.BoundaryConditionType[self._Entity.NxType.ToString()]
8242	@property
8243	def NyType(self) -> types.BoundaryConditionType:
8244		return types.BoundaryConditionType[self._Entity.NyType.ToString()]
8246	@property
8247	def NxyType(self) -> types.BoundaryConditionType:
8248		return types.BoundaryConditionType[self._Entity.NxyType.ToString()]
8250	@property
8251	def MxType(self) -> types.BoundaryConditionType:
8252		return types.BoundaryConditionType[self._Entity.MxType.ToString()]
8254	@property
8255	def MyType(self) -> types.BoundaryConditionType:
8256		return types.BoundaryConditionType[self._Entity.MyType.ToString()]
8258	@property
8259	def MxyType(self) -> types.BoundaryConditionType:
8260		return types.BoundaryConditionType[self._Entity.MxyType.ToString()]
8262	@property
8263	def QxType(self) -> types.BoundaryConditionType:
8264		return types.BoundaryConditionType[self._Entity.QxType.ToString()]
8266	@property
8267	def QyType(self) -> types.BoundaryConditionType:
8268		return types.BoundaryConditionType[self._Entity.QyType.ToString()]
class LoadPropertyUserGeneralPanelRowBulkUpdater(LoadPropertyUserRowBulkUpdater):
8303class LoadPropertyUserGeneralPanelRowBulkUpdater(LoadPropertyUserRowBulkUpdater):
8304	def __init__(self, loadPropertyUserGeneralPanelRowBulkUpdater: _api.LoadPropertyUserGeneralPanelRowBulkUpdater):
8305		self._Entity = loadPropertyUserGeneralPanelRowBulkUpdater
8306
8307	def GetBulkUpdater(application: Application, items: list[LoadPropertyUserGeneralPanelRow]) -> LoadPropertyUserGeneralPanelRowBulkUpdater:
8308		itemsList = List[_api.LoadPropertyUserGeneralPanelRow]()
8309		if items is not None:
8310			for thing in items:
8311				if thing is not None:
8312					itemsList.Add(thing._Entity)
8313		return LoadPropertyUserGeneralPanelRowBulkUpdater(_api.LoadPropertyUserGeneralPanelRowBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
LoadPropertyUserGeneralPanelRowBulkUpdater( loadPropertyUserGeneralPanelRowBulkUpdater: HyperX.Scripting.LoadPropertyUserGeneralPanelRowBulkUpdater)
8304	def __init__(self, loadPropertyUserGeneralPanelRowBulkUpdater: _api.LoadPropertyUserGeneralPanelRowBulkUpdater):
8305		self._Entity = loadPropertyUserGeneralPanelRowBulkUpdater
def GetBulkUpdater( application: Application, items: list[LoadPropertyUserGeneralPanelRow]) -> LoadPropertyUserGeneralPanelRowBulkUpdater:
8307	def GetBulkUpdater(application: Application, items: list[LoadPropertyUserGeneralPanelRow]) -> LoadPropertyUserGeneralPanelRowBulkUpdater:
8308		itemsList = List[_api.LoadPropertyUserGeneralPanelRow]()
8309		if items is not None:
8310			for thing in items:
8311				if thing is not None:
8312					itemsList.Add(thing._Entity)
8313		return LoadPropertyUserGeneralPanelRowBulkUpdater(_api.LoadPropertyUserGeneralPanelRowBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
Inherited Members
BulkUpdaterBase
Update
class LoadPropertyFea(LoadProperty):
8316class LoadPropertyFea(LoadProperty):
8317	def __init__(self, loadPropertyFea: _api.LoadPropertyFea):
8318		self._Entity = loadPropertyFea
8319
8320	@property
8321	def HasNx(self) -> bool:
8322		return self._Entity.HasNx
8323
8324	@property
8325	def HasNy(self) -> bool:
8326		return self._Entity.HasNy
8327
8328	@property
8329	def HasNxy(self) -> bool:
8330		return self._Entity.HasNxy
8331
8332	@property
8333	def HasMx(self) -> bool:
8334		return self._Entity.HasMx
8335
8336	@property
8337	def HasMy(self) -> bool:
8338		return self._Entity.HasMy
8339
8340	@property
8341	def HasMxy(self) -> bool:
8342		return self._Entity.HasMxy
8343
8344	@property
8345	def HasQx(self) -> bool:
8346		return self._Entity.HasQx
8347
8348	@property
8349	def HasQy(self) -> bool:
8350		return self._Entity.HasQy
8351
8352	@property
8353	def HasM1a(self) -> bool:
8354		return self._Entity.HasM1a
8355
8356	@property
8357	def HasM1b(self) -> bool:
8358		return self._Entity.HasM1b
8359
8360	@property
8361	def M2a(self) -> bool:
8362		return self._Entity.M2a
8363
8364	@property
8365	def V1(self) -> bool:
8366		return self._Entity.V1
8367
8368	@property
8369	def V2(self) -> bool:
8370		return self._Entity.V2
8371
8372	@property
8373	def Axial(self) -> bool:
8374		return self._Entity.Axial
8375
8376	@property
8377	def Torque(self) -> bool:
8378		return self._Entity.Torque
8379
8380	@property
8381	def Tension(self) -> bool:
8382		return self._Entity.Tension
8383
8384	@property
8385	def Shear(self) -> bool:
8386		return self._Entity.Shear
8387
8388	@property
8389	def Moment(self) -> bool:
8390		return self._Entity.Moment
8391
8392	@HasNx.setter
8393	def HasNx(self, value: bool) -> None:
8394		self._Entity.HasNx = value
8395
8396	@HasNy.setter
8397	def HasNy(self, value: bool) -> None:
8398		self._Entity.HasNy = value
8399
8400	@HasNxy.setter
8401	def HasNxy(self, value: bool) -> None:
8402		self._Entity.HasNxy = value
8403
8404	@HasMx.setter
8405	def HasMx(self, value: bool) -> None:
8406		self._Entity.HasMx = value
8407
8408	@HasMy.setter
8409	def HasMy(self, value: bool) -> None:
8410		self._Entity.HasMy = value
8411
8412	@HasMxy.setter
8413	def HasMxy(self, value: bool) -> None:
8414		self._Entity.HasMxy = value
8415
8416	@HasQx.setter
8417	def HasQx(self, value: bool) -> None:
8418		self._Entity.HasQx = value
8419
8420	@HasQy.setter
8421	def HasQy(self, value: bool) -> None:
8422		self._Entity.HasQy = value
8423
8424	@HasM1a.setter
8425	def HasM1a(self, value: bool) -> None:
8426		self._Entity.HasM1a = value
8427
8428	@HasM1b.setter
8429	def HasM1b(self, value: bool) -> None:
8430		self._Entity.HasM1b = value
8431
8432	@M2a.setter
8433	def M2a(self, value: bool) -> None:
8434		self._Entity.M2a = value
8435
8436	@V1.setter
8437	def V1(self, value: bool) -> None:
8438		self._Entity.V1 = value
8439
8440	@V2.setter
8441	def V2(self, value: bool) -> None:
8442		self._Entity.V2 = value
8443
8444	@Axial.setter
8445	def Axial(self, value: bool) -> None:
8446		self._Entity.Axial = value
8447
8448	@Torque.setter
8449	def Torque(self, value: bool) -> None:
8450		self._Entity.Torque = value
8451
8452	@Tension.setter
8453	def Tension(self, value: bool) -> None:
8454		self._Entity.Tension = value
8455
8456	@Shear.setter
8457	def Shear(self, value: bool) -> None:
8458		self._Entity.Shear = value
8459
8460	@Moment.setter
8461	def Moment(self, value: bool) -> None:
8462		self._Entity.Moment = value

Represents an entity with an ID and Name.

LoadPropertyFea(loadPropertyFea: HyperX.Scripting.LoadPropertyFea)
8317	def __init__(self, loadPropertyFea: _api.LoadPropertyFea):
8318		self._Entity = loadPropertyFea
HasNx: bool
8320	@property
8321	def HasNx(self) -> bool:
8322		return self._Entity.HasNx
HasNy: bool
8324	@property
8325	def HasNy(self) -> bool:
8326		return self._Entity.HasNy
HasNxy: bool
8328	@property
8329	def HasNxy(self) -> bool:
8330		return self._Entity.HasNxy
HasMx: bool
8332	@property
8333	def HasMx(self) -> bool:
8334		return self._Entity.HasMx
HasMy: bool
8336	@property
8337	def HasMy(self) -> bool:
8338		return self._Entity.HasMy
HasMxy: bool
8340	@property
8341	def HasMxy(self) -> bool:
8342		return self._Entity.HasMxy
HasQx: bool
8344	@property
8345	def HasQx(self) -> bool:
8346		return self._Entity.HasQx
HasQy: bool
8348	@property
8349	def HasQy(self) -> bool:
8350		return self._Entity.HasQy
HasM1a: bool
8352	@property
8353	def HasM1a(self) -> bool:
8354		return self._Entity.HasM1a
HasM1b: bool
8356	@property
8357	def HasM1b(self) -> bool:
8358		return self._Entity.HasM1b
M2a: bool
8360	@property
8361	def M2a(self) -> bool:
8362		return self._Entity.M2a
V1: bool
8364	@property
8365	def V1(self) -> bool:
8366		return self._Entity.V1
V2: bool
8368	@property
8369	def V2(self) -> bool:
8370		return self._Entity.V2
Axial: bool
8372	@property
8373	def Axial(self) -> bool:
8374		return self._Entity.Axial
Torque: bool
8376	@property
8377	def Torque(self) -> bool:
8378		return self._Entity.Torque
Tension: bool
8380	@property
8381	def Tension(self) -> bool:
8382		return self._Entity.Tension
Shear: bool
8384	@property
8385	def Shear(self) -> bool:
8386		return self._Entity.Shear
Moment: bool
8388	@property
8389	def Moment(self) -> bool:
8390		return self._Entity.Moment
class LoadPropertyAverage(LoadPropertyFea):
8465class LoadPropertyAverage(LoadPropertyFea):
8466	def __init__(self, loadPropertyAverage: _api.LoadPropertyAverage):
8467		self._Entity = loadPropertyAverage
8468
8469	@property
8470	def ElementType(self) -> types.LoadPropertyAverageElementType:
8471		return types.LoadPropertyAverageElementType[self._Entity.ElementType.ToString()]
8472
8473	@ElementType.setter
8474	def ElementType(self, value: types.LoadPropertyAverageElementType) -> None:
8475		self._Entity.ElementType = _types.LoadPropertyAverageElementType(value.value)

Represents an entity with an ID and Name.

LoadPropertyAverage(loadPropertyAverage: HyperX.Scripting.LoadPropertyAverage)
8466	def __init__(self, loadPropertyAverage: _api.LoadPropertyAverage):
8467		self._Entity = loadPropertyAverage
8469	@property
8470	def ElementType(self) -> types.LoadPropertyAverageElementType:
8471		return types.LoadPropertyAverageElementType[self._Entity.ElementType.ToString()]
class LoadPropertyElementBased(LoadPropertyFea):
8478class LoadPropertyElementBased(LoadPropertyFea):
8479	def __init__(self, loadPropertyElementBased: _api.LoadPropertyElementBased):
8480		self._Entity = loadPropertyElementBased

Represents an entity with an ID and Name.

LoadPropertyElementBased(loadPropertyElementBased: HyperX.Scripting.LoadPropertyElementBased)
8479	def __init__(self, loadPropertyElementBased: _api.LoadPropertyElementBased):
8480		self._Entity = loadPropertyElementBased
class LoadPropertyNeighborAverage(LoadPropertyFea):
8483class LoadPropertyNeighborAverage(LoadPropertyFea):
8484	def __init__(self, loadPropertyNeighborAverage: _api.LoadPropertyNeighborAverage):
8485		self._Entity = loadPropertyNeighborAverage
8486
8487	@property
8488	def NumberOfNeighborsPerSide(self) -> int:
8489		return self._Entity.NumberOfNeighborsPerSide
8490
8491	@NumberOfNeighborsPerSide.setter
8492	def NumberOfNeighborsPerSide(self, value: int) -> None:
8493		self._Entity.NumberOfNeighborsPerSide = value

Represents an entity with an ID and Name.

LoadPropertyNeighborAverage( loadPropertyNeighborAverage: HyperX.Scripting.LoadPropertyNeighborAverage)
8484	def __init__(self, loadPropertyNeighborAverage: _api.LoadPropertyNeighborAverage):
8485		self._Entity = loadPropertyNeighborAverage
NumberOfNeighborsPerSide: int
8487	@property
8488	def NumberOfNeighborsPerSide(self) -> int:
8489		return self._Entity.NumberOfNeighborsPerSide
class LoadPropertyPeakLoad(LoadPropertyFea):
8496class LoadPropertyPeakLoad(LoadPropertyFea):
8497	def __init__(self, loadPropertyPeakLoad: _api.LoadPropertyPeakLoad):
8498		self._Entity = loadPropertyPeakLoad
8499
8500	@property
8501	def ElementScope(self) -> types.LoadPropertyPeakElementScope:
8502		return types.LoadPropertyPeakElementScope[self._Entity.ElementScope.ToString()]
8503
8504	@ElementScope.setter
8505	def ElementScope(self, value: types.LoadPropertyPeakElementScope) -> None:
8506		self._Entity.ElementScope = _types.LoadPropertyPeakElementScope(value.value)

Represents an entity with an ID and Name.

LoadPropertyPeakLoad(loadPropertyPeakLoad: HyperX.Scripting.LoadPropertyPeakLoad)
8497	def __init__(self, loadPropertyPeakLoad: _api.LoadPropertyPeakLoad):
8498		self._Entity = loadPropertyPeakLoad
8500	@property
8501	def ElementScope(self) -> types.LoadPropertyPeakElementScope:
8502		return types.LoadPropertyPeakElementScope[self._Entity.ElementScope.ToString()]
class LoadPropertyStatistical(LoadPropertyFea):
8509class LoadPropertyStatistical(LoadPropertyFea):
8510	def __init__(self, loadPropertyStatistical: _api.LoadPropertyStatistical):
8511		self._Entity = loadPropertyStatistical
8512
8513	@property
8514	def NSigma(self) -> int:
8515		return self._Entity.NSigma
8516
8517	@NSigma.setter
8518	def NSigma(self, value: int) -> None:
8519		self._Entity.NSigma = value

Represents an entity with an ID and Name.

LoadPropertyStatistical(loadPropertyStatistical: HyperX.Scripting.LoadPropertyStatistical)
8510	def __init__(self, loadPropertyStatistical: _api.LoadPropertyStatistical):
8511		self._Entity = loadPropertyStatistical
NSigma: int
8513	@property
8514	def NSigma(self) -> int:
8515		return self._Entity.NSigma
class LoadPropertyUserFeaRowCol(IdNameEntityCol, typing.Generic[~T]):
8522class LoadPropertyUserFeaRowCol(IdNameEntityCol, Generic[T]):
8523	def __init__(self, loadPropertyUserFeaRowCol: _api.LoadPropertyUserFeaRowCol):
8524		self._Entity = loadPropertyUserFeaRowCol
8525		self._CollectedClass = T
8526
8527	@property
8528	def LoadPropertyUserFeaRowColList(self) -> tuple[T]:
8529		if self._Entity.Count() <= 0:
8530			return ()
8531		thisClass = type(self._Entity._items[0]).__name__
8532		givenClass = T
8533		for subclass in T.__subclasses__():
8534			if subclass.__name__ == thisClass:
8535				givenClass = subclass
8536		return tuple([givenClass(loadPropertyUserFeaRowCol) for loadPropertyUserFeaRowCol in self._Entity])
8537
8538	def AddScenario(self, name: str = None) -> T:
8539		return self._Entity.AddScenario(name)
8540
8541	@overload
8542	def DeleteScenario(self, scenarioId: int) -> bool: ...
8543
8544	@overload
8545	def DeleteScenario(self, scenarioName: str) -> bool: ...
8546
8547	@overload
8548	def Get(self, name: str) -> T: ...
8549
8550	@overload
8551	def Get(self, id: int) -> T: ...
8552
8553	def DeleteScenario(self, item1 = None) -> bool:
8554		if isinstance(item1, int):
8555			return self._Entity.DeleteScenario(item1)
8556
8557		if isinstance(item1, str):
8558			return self._Entity.DeleteScenario(item1)
8559
8560		return self._Entity.DeleteScenario(item1)
8561
8562	def Get(self, item1 = None) -> T:
8563		if isinstance(item1, str):
8564			return super().Get(item1)
8565
8566		if isinstance(item1, int):
8567			return super().Get(item1)
8568
8569		return self._Entity.Get(item1)
8570
8571	def __getitem__(self, index: int):
8572		return self.LoadPropertyUserFeaRowColList[index]
8573
8574	def __iter__(self):
8575		yield from self.LoadPropertyUserFeaRowColList
8576
8577	def __len__(self):
8578		return len(self.LoadPropertyUserFeaRowColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

LoadPropertyUserFeaRowColList: tuple[~T]
8527	@property
8528	def LoadPropertyUserFeaRowColList(self) -> tuple[T]:
8529		if self._Entity.Count() <= 0:
8530			return ()
8531		thisClass = type(self._Entity._items[0]).__name__
8532		givenClass = T
8533		for subclass in T.__subclasses__():
8534			if subclass.__name__ == thisClass:
8535				givenClass = subclass
8536		return tuple([givenClass(loadPropertyUserFeaRowCol) for loadPropertyUserFeaRowCol in self._Entity])
def AddScenario(self, name: str = None) -> ~T:
8538	def AddScenario(self, name: str = None) -> T:
8539		return self._Entity.AddScenario(name)
def DeleteScenario(self, item1=None) -> bool:
8553	def DeleteScenario(self, item1 = None) -> bool:
8554		if isinstance(item1, int):
8555			return self._Entity.DeleteScenario(item1)
8556
8557		if isinstance(item1, str):
8558			return self._Entity.DeleteScenario(item1)
8559
8560		return self._Entity.DeleteScenario(item1)
class LoadPropertyUserFeaBeamRowCol(hyperx.api.LoadPropertyUserFeaRowCol[hyperx.api.LoadPropertyUserFeaBeamRow]):
8581class LoadPropertyUserFeaBeamRowCol(LoadPropertyUserFeaRowCol[LoadPropertyUserFeaBeamRow]):
8582	def __init__(self, loadPropertyUserFeaBeamRowCol: _api.LoadPropertyUserFeaBeamRowCol):
8583		self._Entity = loadPropertyUserFeaBeamRowCol
8584		self._CollectedClass = LoadPropertyUserFeaBeamRow
8585
8586	@property
8587	def LoadPropertyUserFeaBeamRowColList(self) -> tuple[LoadPropertyUserFeaBeamRow]:
8588		return tuple([LoadPropertyUserFeaBeamRow(loadPropertyUserFeaBeamRowCol) for loadPropertyUserFeaBeamRowCol in self._Entity])
8589
8590	@overload
8591	def DeleteScenario(self, scenarioId: int) -> bool: ...
8592
8593	@overload
8594	def DeleteScenario(self, scenarioName: str) -> bool: ...
8595
8596	@overload
8597	def Get(self, name: str) -> LoadPropertyUserFeaBeamRow: ...
8598
8599	@overload
8600	def Get(self, id: int) -> LoadPropertyUserFeaBeamRow: ...
8601
8602	def DeleteScenario(self, item1 = None) -> bool:
8603		if isinstance(item1, int):
8604			return bool(super().DeleteScenario(item1))
8605
8606		if isinstance(item1, str):
8607			return bool(super().DeleteScenario(item1))
8608
8609		return self._Entity.DeleteScenario(item1)
8610
8611	def Get(self, item1 = None) -> LoadPropertyUserFeaBeamRow:
8612		if isinstance(item1, str):
8613			return LoadPropertyUserFeaBeamRow(super().Get(item1))
8614
8615		if isinstance(item1, int):
8616			return LoadPropertyUserFeaBeamRow(super().Get(item1))
8617
8618		return LoadPropertyUserFeaBeamRow(self._Entity.Get(item1))
8619
8620	def __getitem__(self, index: int):
8621		return self.LoadPropertyUserFeaBeamRowColList[index]
8622
8623	def __iter__(self):
8624		yield from self.LoadPropertyUserFeaBeamRowColList
8625
8626	def __len__(self):
8627		return len(self.LoadPropertyUserFeaBeamRowColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

LoadPropertyUserFeaBeamRowCol( loadPropertyUserFeaBeamRowCol: HyperX.Scripting.LoadPropertyUserFeaBeamRowCol)
8582	def __init__(self, loadPropertyUserFeaBeamRowCol: _api.LoadPropertyUserFeaBeamRowCol):
8583		self._Entity = loadPropertyUserFeaBeamRowCol
8584		self._CollectedClass = LoadPropertyUserFeaBeamRow
LoadPropertyUserFeaBeamRowColList: tuple[LoadPropertyUserFeaBeamRow]
8586	@property
8587	def LoadPropertyUserFeaBeamRowColList(self) -> tuple[LoadPropertyUserFeaBeamRow]:
8588		return tuple([LoadPropertyUserFeaBeamRow(loadPropertyUserFeaBeamRowCol) for loadPropertyUserFeaBeamRowCol in self._Entity])
def DeleteScenario(self, item1=None) -> bool:
8602	def DeleteScenario(self, item1 = None) -> bool:
8603		if isinstance(item1, int):
8604			return bool(super().DeleteScenario(item1))
8605
8606		if isinstance(item1, str):
8607			return bool(super().DeleteScenario(item1))
8608
8609		return self._Entity.DeleteScenario(item1)
def Get(self, item1=None) -> LoadPropertyUserFeaBeamRow:
8611	def Get(self, item1 = None) -> LoadPropertyUserFeaBeamRow:
8612		if isinstance(item1, str):
8613			return LoadPropertyUserFeaBeamRow(super().Get(item1))
8614
8615		if isinstance(item1, int):
8616			return LoadPropertyUserFeaBeamRow(super().Get(item1))
8617
8618		return LoadPropertyUserFeaBeamRow(self._Entity.Get(item1))
class LoadPropertyUserFeaBeam(LoadProperty):
8630class LoadPropertyUserFeaBeam(LoadProperty):
8631	def __init__(self, loadPropertyUserFeaBeam: _api.LoadPropertyUserFeaBeam):
8632		self._Entity = loadPropertyUserFeaBeam
8633
8634	@property
8635	def UserFeaRows(self) -> LoadPropertyUserFeaBeamRowCol:
8636		result = self._Entity.UserFeaRows
8637		return LoadPropertyUserFeaBeamRowCol(result) if result is not None else None

Represents an entity with an ID and Name.

LoadPropertyUserFeaBeam(loadPropertyUserFeaBeam: HyperX.Scripting.LoadPropertyUserFeaBeam)
8631	def __init__(self, loadPropertyUserFeaBeam: _api.LoadPropertyUserFeaBeam):
8632		self._Entity = loadPropertyUserFeaBeam
UserFeaRows: LoadPropertyUserFeaBeamRowCol
8634	@property
8635	def UserFeaRows(self) -> LoadPropertyUserFeaBeamRowCol:
8636		result = self._Entity.UserFeaRows
8637		return LoadPropertyUserFeaBeamRowCol(result) if result is not None else None
class LoadPropertyUserFeaJointRowCol(hyperx.api.LoadPropertyUserFeaRowCol[hyperx.api.LoadPropertyUserFeaJointRow]):
8640class LoadPropertyUserFeaJointRowCol(LoadPropertyUserFeaRowCol[LoadPropertyUserFeaJointRow]):
8641	def __init__(self, loadPropertyUserFeaJointRowCol: _api.LoadPropertyUserFeaJointRowCol):
8642		self._Entity = loadPropertyUserFeaJointRowCol
8643		self._CollectedClass = LoadPropertyUserFeaJointRow
8644
8645	@property
8646	def LoadPropertyUserFeaJointRowColList(self) -> tuple[LoadPropertyUserFeaJointRow]:
8647		return tuple([LoadPropertyUserFeaJointRow(loadPropertyUserFeaJointRowCol) for loadPropertyUserFeaJointRowCol in self._Entity])
8648
8649	@overload
8650	def DeleteScenario(self, scenarioId: int) -> bool: ...
8651
8652	@overload
8653	def DeleteScenario(self, scenarioName: str) -> bool: ...
8654
8655	@overload
8656	def Get(self, name: str) -> LoadPropertyUserFeaJointRow: ...
8657
8658	@overload
8659	def Get(self, id: int) -> LoadPropertyUserFeaJointRow: ...
8660
8661	def DeleteScenario(self, item1 = None) -> bool:
8662		if isinstance(item1, int):
8663			return bool(super().DeleteScenario(item1))
8664
8665		if isinstance(item1, str):
8666			return bool(super().DeleteScenario(item1))
8667
8668		return self._Entity.DeleteScenario(item1)
8669
8670	def Get(self, item1 = None) -> LoadPropertyUserFeaJointRow:
8671		if isinstance(item1, str):
8672			return LoadPropertyUserFeaJointRow(super().Get(item1))
8673
8674		if isinstance(item1, int):
8675			return LoadPropertyUserFeaJointRow(super().Get(item1))
8676
8677		return LoadPropertyUserFeaJointRow(self._Entity.Get(item1))
8678
8679	def __getitem__(self, index: int):
8680		return self.LoadPropertyUserFeaJointRowColList[index]
8681
8682	def __iter__(self):
8683		yield from self.LoadPropertyUserFeaJointRowColList
8684
8685	def __len__(self):
8686		return len(self.LoadPropertyUserFeaJointRowColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

LoadPropertyUserFeaJointRowCol( loadPropertyUserFeaJointRowCol: HyperX.Scripting.LoadPropertyUserFeaJointRowCol)
8641	def __init__(self, loadPropertyUserFeaJointRowCol: _api.LoadPropertyUserFeaJointRowCol):
8642		self._Entity = loadPropertyUserFeaJointRowCol
8643		self._CollectedClass = LoadPropertyUserFeaJointRow
LoadPropertyUserFeaJointRowColList: tuple[LoadPropertyUserFeaJointRow]
8645	@property
8646	def LoadPropertyUserFeaJointRowColList(self) -> tuple[LoadPropertyUserFeaJointRow]:
8647		return tuple([LoadPropertyUserFeaJointRow(loadPropertyUserFeaJointRowCol) for loadPropertyUserFeaJointRowCol in self._Entity])
def DeleteScenario(self, item1=None) -> bool:
8661	def DeleteScenario(self, item1 = None) -> bool:
8662		if isinstance(item1, int):
8663			return bool(super().DeleteScenario(item1))
8664
8665		if isinstance(item1, str):
8666			return bool(super().DeleteScenario(item1))
8667
8668		return self._Entity.DeleteScenario(item1)
def Get(self, item1=None) -> LoadPropertyUserFeaJointRow:
8670	def Get(self, item1 = None) -> LoadPropertyUserFeaJointRow:
8671		if isinstance(item1, str):
8672			return LoadPropertyUserFeaJointRow(super().Get(item1))
8673
8674		if isinstance(item1, int):
8675			return LoadPropertyUserFeaJointRow(super().Get(item1))
8676
8677		return LoadPropertyUserFeaJointRow(self._Entity.Get(item1))
class LoadPropertyUserFeaJoint(LoadProperty):
8689class LoadPropertyUserFeaJoint(LoadProperty):
8690	def __init__(self, loadPropertyUserFeaJoint: _api.LoadPropertyUserFeaJoint):
8691		self._Entity = loadPropertyUserFeaJoint
8692
8693	@property
8694	def UserFeaRows(self) -> LoadPropertyUserFeaJointRowCol:
8695		result = self._Entity.UserFeaRows
8696		return LoadPropertyUserFeaJointRowCol(result) if result is not None else None

Represents an entity with an ID and Name.

LoadPropertyUserFeaJoint(loadPropertyUserFeaJoint: HyperX.Scripting.LoadPropertyUserFeaJoint)
8690	def __init__(self, loadPropertyUserFeaJoint: _api.LoadPropertyUserFeaJoint):
8691		self._Entity = loadPropertyUserFeaJoint
UserFeaRows: LoadPropertyUserFeaJointRowCol
8693	@property
8694	def UserFeaRows(self) -> LoadPropertyUserFeaJointRowCol:
8695		result = self._Entity.UserFeaRows
8696		return LoadPropertyUserFeaJointRowCol(result) if result is not None else None
class LoadPropertyUserFeaPanelRowCol(hyperx.api.LoadPropertyUserFeaRowCol[hyperx.api.LoadPropertyUserFeaPanelRow]):
8699class LoadPropertyUserFeaPanelRowCol(LoadPropertyUserFeaRowCol[LoadPropertyUserFeaPanelRow]):
8700	def __init__(self, loadPropertyUserFeaPanelRowCol: _api.LoadPropertyUserFeaPanelRowCol):
8701		self._Entity = loadPropertyUserFeaPanelRowCol
8702		self._CollectedClass = LoadPropertyUserFeaPanelRow
8703
8704	@property
8705	def LoadPropertyUserFeaPanelRowColList(self) -> tuple[LoadPropertyUserFeaPanelRow]:
8706		return tuple([LoadPropertyUserFeaPanelRow(loadPropertyUserFeaPanelRowCol) for loadPropertyUserFeaPanelRowCol in self._Entity])
8707
8708	@overload
8709	def DeleteScenario(self, scenarioId: int) -> bool: ...
8710
8711	@overload
8712	def DeleteScenario(self, scenarioName: str) -> bool: ...
8713
8714	@overload
8715	def Get(self, name: str) -> LoadPropertyUserFeaPanelRow: ...
8716
8717	@overload
8718	def Get(self, id: int) -> LoadPropertyUserFeaPanelRow: ...
8719
8720	def DeleteScenario(self, item1 = None) -> bool:
8721		if isinstance(item1, int):
8722			return bool(super().DeleteScenario(item1))
8723
8724		if isinstance(item1, str):
8725			return bool(super().DeleteScenario(item1))
8726
8727		return self._Entity.DeleteScenario(item1)
8728
8729	def Get(self, item1 = None) -> LoadPropertyUserFeaPanelRow:
8730		if isinstance(item1, str):
8731			return LoadPropertyUserFeaPanelRow(super().Get(item1))
8732
8733		if isinstance(item1, int):
8734			return LoadPropertyUserFeaPanelRow(super().Get(item1))
8735
8736		return LoadPropertyUserFeaPanelRow(self._Entity.Get(item1))
8737
8738	def __getitem__(self, index: int):
8739		return self.LoadPropertyUserFeaPanelRowColList[index]
8740
8741	def __iter__(self):
8742		yield from self.LoadPropertyUserFeaPanelRowColList
8743
8744	def __len__(self):
8745		return len(self.LoadPropertyUserFeaPanelRowColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

LoadPropertyUserFeaPanelRowCol( loadPropertyUserFeaPanelRowCol: HyperX.Scripting.LoadPropertyUserFeaPanelRowCol)
8700	def __init__(self, loadPropertyUserFeaPanelRowCol: _api.LoadPropertyUserFeaPanelRowCol):
8701		self._Entity = loadPropertyUserFeaPanelRowCol
8702		self._CollectedClass = LoadPropertyUserFeaPanelRow
LoadPropertyUserFeaPanelRowColList: tuple[LoadPropertyUserFeaPanelRow]
8704	@property
8705	def LoadPropertyUserFeaPanelRowColList(self) -> tuple[LoadPropertyUserFeaPanelRow]:
8706		return tuple([LoadPropertyUserFeaPanelRow(loadPropertyUserFeaPanelRowCol) for loadPropertyUserFeaPanelRowCol in self._Entity])
def DeleteScenario(self, item1=None) -> bool:
8720	def DeleteScenario(self, item1 = None) -> bool:
8721		if isinstance(item1, int):
8722			return bool(super().DeleteScenario(item1))
8723
8724		if isinstance(item1, str):
8725			return bool(super().DeleteScenario(item1))
8726
8727		return self._Entity.DeleteScenario(item1)
def Get(self, item1=None) -> LoadPropertyUserFeaPanelRow:
8729	def Get(self, item1 = None) -> LoadPropertyUserFeaPanelRow:
8730		if isinstance(item1, str):
8731			return LoadPropertyUserFeaPanelRow(super().Get(item1))
8732
8733		if isinstance(item1, int):
8734			return LoadPropertyUserFeaPanelRow(super().Get(item1))
8735
8736		return LoadPropertyUserFeaPanelRow(self._Entity.Get(item1))
class LoadPropertyUserFeaPanel(LoadProperty):
8748class LoadPropertyUserFeaPanel(LoadProperty):
8749	def __init__(self, loadPropertyUserFeaPanel: _api.LoadPropertyUserFeaPanel):
8750		self._Entity = loadPropertyUserFeaPanel
8751
8752	@property
8753	def UserFeaRows(self) -> LoadPropertyUserFeaPanelRowCol:
8754		result = self._Entity.UserFeaRows
8755		return LoadPropertyUserFeaPanelRowCol(result) if result is not None else None
8756
8757	def SetIsZeroCurvature(self, isZeroCurvature: bool) -> None:
8758		return self._Entity.SetIsZeroCurvature(isZeroCurvature)

Represents an entity with an ID and Name.

LoadPropertyUserFeaPanel(loadPropertyUserFeaPanel: HyperX.Scripting.LoadPropertyUserFeaPanel)
8749	def __init__(self, loadPropertyUserFeaPanel: _api.LoadPropertyUserFeaPanel):
8750		self._Entity = loadPropertyUserFeaPanel
UserFeaRows: LoadPropertyUserFeaPanelRowCol
8752	@property
8753	def UserFeaRows(self) -> LoadPropertyUserFeaPanelRowCol:
8754		result = self._Entity.UserFeaRows
8755		return LoadPropertyUserFeaPanelRowCol(result) if result is not None else None
def SetIsZeroCurvature(self, isZeroCurvature: bool) -> None:
8757	def SetIsZeroCurvature(self, isZeroCurvature: bool) -> None:
8758		return self._Entity.SetIsZeroCurvature(isZeroCurvature)
class LoadPropertyUserGeneralDoubleRow(IdNameEntity):
8761class LoadPropertyUserGeneralDoubleRow(IdNameEntity):
8762	def __init__(self, loadPropertyUserGeneralDoubleRow: _api.LoadPropertyUserGeneralDoubleRow):
8763		self._Entity = loadPropertyUserGeneralDoubleRow
8764
8765	@property
8766	def MechanicalRow(self) -> LoadPropertyUserRow:
8767		thisClass = type(self._Entity.MechanicalRow).__name__
8768		givenClass = LoadPropertyUserRow
8769		for subclass in LoadPropertyUserRow.__subclasses__():
8770			if subclass.__name__ == thisClass:
8771				givenClass = subclass
8772		result = self._Entity.MechanicalRow
8773		return givenClass(result) if result is not None else None
8774
8775	@property
8776	def ThermalRow(self) -> LoadPropertyUserRow:
8777		thisClass = type(self._Entity.ThermalRow).__name__
8778		givenClass = LoadPropertyUserRow
8779		for subclass in LoadPropertyUserRow.__subclasses__():
8780			if subclass.__name__ == thisClass:
8781				givenClass = subclass
8782		result = self._Entity.ThermalRow
8783		return givenClass(result) if result is not None else None
8784
8785	def SetName(self, name: str) -> None:
8786		return self._Entity.SetName(name)

Represents an entity with an ID and Name.

LoadPropertyUserGeneralDoubleRow( loadPropertyUserGeneralDoubleRow: HyperX.Scripting.LoadPropertyUserGeneralDoubleRow)
8762	def __init__(self, loadPropertyUserGeneralDoubleRow: _api.LoadPropertyUserGeneralDoubleRow):
8763		self._Entity = loadPropertyUserGeneralDoubleRow
MechanicalRow: LoadPropertyUserRow
8765	@property
8766	def MechanicalRow(self) -> LoadPropertyUserRow:
8767		thisClass = type(self._Entity.MechanicalRow).__name__
8768		givenClass = LoadPropertyUserRow
8769		for subclass in LoadPropertyUserRow.__subclasses__():
8770			if subclass.__name__ == thisClass:
8771				givenClass = subclass
8772		result = self._Entity.MechanicalRow
8773		return givenClass(result) if result is not None else None
ThermalRow: LoadPropertyUserRow
8775	@property
8776	def ThermalRow(self) -> LoadPropertyUserRow:
8777		thisClass = type(self._Entity.ThermalRow).__name__
8778		givenClass = LoadPropertyUserRow
8779		for subclass in LoadPropertyUserRow.__subclasses__():
8780			if subclass.__name__ == thisClass:
8781				givenClass = subclass
8782		result = self._Entity.ThermalRow
8783		return givenClass(result) if result is not None else None
def SetName(self, name: str) -> None:
8785	def SetName(self, name: str) -> None:
8786		return self._Entity.SetName(name)
Inherited Members
IdNameEntity
Name
IdEntity
Id
class LoadPropertyUserGeneralBeamDoubleRow(LoadPropertyUserGeneralDoubleRow):
8789class LoadPropertyUserGeneralBeamDoubleRow(LoadPropertyUserGeneralDoubleRow):
8790	def __init__(self, loadPropertyUserGeneralBeamDoubleRow: _api.LoadPropertyUserGeneralBeamDoubleRow):
8791		self._Entity = loadPropertyUserGeneralBeamDoubleRow
8792
8793	@property
8794	def MechanicalRow(self) -> LoadPropertyUserRow:
8795		thisClass = type(self._Entity.MechanicalRow).__name__
8796		givenClass = LoadPropertyUserRow
8797		for subclass in LoadPropertyUserRow.__subclasses__():
8798			if subclass.__name__ == thisClass:
8799				givenClass = subclass
8800		result = self._Entity.MechanicalRow
8801		return givenClass(result) if result is not None else None
8802
8803	@property
8804	def ThermalRow(self) -> LoadPropertyUserRow:
8805		thisClass = type(self._Entity.ThermalRow).__name__
8806		givenClass = LoadPropertyUserRow
8807		for subclass in LoadPropertyUserRow.__subclasses__():
8808			if subclass.__name__ == thisClass:
8809				givenClass = subclass
8810		result = self._Entity.ThermalRow
8811		return givenClass(result) if result is not None else None
8812
8813	@property
8814	def M1AType(self) -> types.BoundaryConditionType:
8815		return types.BoundaryConditionType[self._Entity.M1AType.ToString()]
8816
8817	@property
8818	def M2AType(self) -> types.BoundaryConditionType:
8819		return types.BoundaryConditionType[self._Entity.M2AType.ToString()]
8820
8821	@property
8822	def M1BType(self) -> types.BoundaryConditionType:
8823		return types.BoundaryConditionType[self._Entity.M1BType.ToString()]
8824
8825	@property
8826	def M2BType(self) -> types.BoundaryConditionType:
8827		return types.BoundaryConditionType[self._Entity.M2BType.ToString()]
8828
8829	@property
8830	def V1Type(self) -> types.BoundaryConditionType:
8831		return types.BoundaryConditionType[self._Entity.V1Type.ToString()]
8832
8833	@property
8834	def V2Type(self) -> types.BoundaryConditionType:
8835		return types.BoundaryConditionType[self._Entity.V2Type.ToString()]
8836
8837	@property
8838	def AxialType(self) -> types.BoundaryConditionType:
8839		return types.BoundaryConditionType[self._Entity.AxialType.ToString()]
8840
8841	@property
8842	def TorqueType(self) -> types.BoundaryConditionType:
8843		return types.BoundaryConditionType[self._Entity.TorqueType.ToString()]
8844
8845	def SetM1AType(self, type: types.BoundaryConditionType) -> None:
8846		return self._Entity.SetM1AType(_types.BoundaryConditionType(type.value))
8847
8848	def SetM2AType(self, type: types.BoundaryConditionType) -> None:
8849		return self._Entity.SetM2AType(_types.BoundaryConditionType(type.value))
8850
8851	def SetM1BType(self, type: types.BoundaryConditionType) -> None:
8852		return self._Entity.SetM1BType(_types.BoundaryConditionType(type.value))
8853
8854	def SetM2BType(self, type: types.BoundaryConditionType) -> None:
8855		return self._Entity.SetM2BType(_types.BoundaryConditionType(type.value))
8856
8857	def SetV1Type(self, type: types.BoundaryConditionType) -> None:
8858		return self._Entity.SetV1Type(_types.BoundaryConditionType(type.value))
8859
8860	def SetV2Type(self, type: types.BoundaryConditionType) -> None:
8861		return self._Entity.SetV2Type(_types.BoundaryConditionType(type.value))
8862
8863	def SetAxialType(self, type: types.BoundaryConditionType) -> None:
8864		return self._Entity.SetAxialType(_types.BoundaryConditionType(type.value))
8865
8866	def SetTorqueType(self, type: types.BoundaryConditionType) -> None:
8867		return self._Entity.SetTorqueType(_types.BoundaryConditionType(type.value))

Represents an entity with an ID and Name.

LoadPropertyUserGeneralBeamDoubleRow( loadPropertyUserGeneralBeamDoubleRow: HyperX.Scripting.LoadPropertyUserGeneralBeamDoubleRow)
8790	def __init__(self, loadPropertyUserGeneralBeamDoubleRow: _api.LoadPropertyUserGeneralBeamDoubleRow):
8791		self._Entity = loadPropertyUserGeneralBeamDoubleRow
MechanicalRow: LoadPropertyUserRow
8793	@property
8794	def MechanicalRow(self) -> LoadPropertyUserRow:
8795		thisClass = type(self._Entity.MechanicalRow).__name__
8796		givenClass = LoadPropertyUserRow
8797		for subclass in LoadPropertyUserRow.__subclasses__():
8798			if subclass.__name__ == thisClass:
8799				givenClass = subclass
8800		result = self._Entity.MechanicalRow
8801		return givenClass(result) if result is not None else None
ThermalRow: LoadPropertyUserRow
8803	@property
8804	def ThermalRow(self) -> LoadPropertyUserRow:
8805		thisClass = type(self._Entity.ThermalRow).__name__
8806		givenClass = LoadPropertyUserRow
8807		for subclass in LoadPropertyUserRow.__subclasses__():
8808			if subclass.__name__ == thisClass:
8809				givenClass = subclass
8810		result = self._Entity.ThermalRow
8811		return givenClass(result) if result is not None else None
8813	@property
8814	def M1AType(self) -> types.BoundaryConditionType:
8815		return types.BoundaryConditionType[self._Entity.M1AType.ToString()]
8817	@property
8818	def M2AType(self) -> types.BoundaryConditionType:
8819		return types.BoundaryConditionType[self._Entity.M2AType.ToString()]
8821	@property
8822	def M1BType(self) -> types.BoundaryConditionType:
8823		return types.BoundaryConditionType[self._Entity.M1BType.ToString()]
8825	@property
8826	def M2BType(self) -> types.BoundaryConditionType:
8827		return types.BoundaryConditionType[self._Entity.M2BType.ToString()]
8829	@property
8830	def V1Type(self) -> types.BoundaryConditionType:
8831		return types.BoundaryConditionType[self._Entity.V1Type.ToString()]
8833	@property
8834	def V2Type(self) -> types.BoundaryConditionType:
8835		return types.BoundaryConditionType[self._Entity.V2Type.ToString()]
8837	@property
8838	def AxialType(self) -> types.BoundaryConditionType:
8839		return types.BoundaryConditionType[self._Entity.AxialType.ToString()]
TorqueType: hyperx.api.types.BoundaryConditionType
8841	@property
8842	def TorqueType(self) -> types.BoundaryConditionType:
8843		return types.BoundaryConditionType[self._Entity.TorqueType.ToString()]
def SetM1AType(self, type: hyperx.api.types.BoundaryConditionType) -> None:
8845	def SetM1AType(self, type: types.BoundaryConditionType) -> None:
8846		return self._Entity.SetM1AType(_types.BoundaryConditionType(type.value))
def SetM2AType(self, type: hyperx.api.types.BoundaryConditionType) -> None:
8848	def SetM2AType(self, type: types.BoundaryConditionType) -> None:
8849		return self._Entity.SetM2AType(_types.BoundaryConditionType(type.value))
def SetM1BType(self, type: hyperx.api.types.BoundaryConditionType) -> None:
8851	def SetM1BType(self, type: types.BoundaryConditionType) -> None:
8852		return self._Entity.SetM1BType(_types.BoundaryConditionType(type.value))
def SetM2BType(self, type: hyperx.api.types.BoundaryConditionType) -> None:
8854	def SetM2BType(self, type: types.BoundaryConditionType) -> None:
8855		return self._Entity.SetM2BType(_types.BoundaryConditionType(type.value))
def SetV1Type(self, type: hyperx.api.types.BoundaryConditionType) -> None:
8857	def SetV1Type(self, type: types.BoundaryConditionType) -> None:
8858		return self._Entity.SetV1Type(_types.BoundaryConditionType(type.value))
def SetV2Type(self, type: hyperx.api.types.BoundaryConditionType) -> None:
8860	def SetV2Type(self, type: types.BoundaryConditionType) -> None:
8861		return self._Entity.SetV2Type(_types.BoundaryConditionType(type.value))
def SetAxialType(self, type: hyperx.api.types.BoundaryConditionType) -> None:
8863	def SetAxialType(self, type: types.BoundaryConditionType) -> None:
8864		return self._Entity.SetAxialType(_types.BoundaryConditionType(type.value))
def SetTorqueType(self, type: hyperx.api.types.BoundaryConditionType) -> None:
8866	def SetTorqueType(self, type: types.BoundaryConditionType) -> None:
8867		return self._Entity.SetTorqueType(_types.BoundaryConditionType(type.value))
class LoadPropertyUserGeneralRowCol(IdNameEntityCol, typing.Generic[~T]):
8870class LoadPropertyUserGeneralRowCol(IdNameEntityCol, Generic[T]):
8871	def __init__(self, loadPropertyUserGeneralRowCol: _api.LoadPropertyUserGeneralRowCol):
8872		self._Entity = loadPropertyUserGeneralRowCol
8873		self._CollectedClass = T
8874
8875	@property
8876	def LoadPropertyUserGeneralRowColList(self) -> tuple[T]:
8877		if self._Entity.Count() <= 0:
8878			return ()
8879		thisClass = type(self._Entity._items[0]).__name__
8880		givenClass = T
8881		for subclass in T.__subclasses__():
8882			if subclass.__name__ == thisClass:
8883				givenClass = subclass
8884		return tuple([givenClass(loadPropertyUserGeneralRowCol) for loadPropertyUserGeneralRowCol in self._Entity])
8885
8886	def AddScenario(self, name: str = None) -> T:
8887		return self._Entity.AddScenario(name)
8888
8889	@overload
8890	def DeleteScenario(self, scenarioId: int) -> bool: ...
8891
8892	@overload
8893	def DeleteScenario(self, scenarioName: str) -> bool: ...
8894
8895	@overload
8896	def Get(self, name: str) -> T: ...
8897
8898	@overload
8899	def Get(self, id: int) -> T: ...
8900
8901	def DeleteScenario(self, item1 = None) -> bool:
8902		if isinstance(item1, int):
8903			return self._Entity.DeleteScenario(item1)
8904
8905		if isinstance(item1, str):
8906			return self._Entity.DeleteScenario(item1)
8907
8908		return self._Entity.DeleteScenario(item1)
8909
8910	def Get(self, item1 = None) -> T:
8911		if isinstance(item1, str):
8912			return super().Get(item1)
8913
8914		if isinstance(item1, int):
8915			return super().Get(item1)
8916
8917		return self._Entity.Get(item1)
8918
8919	def __getitem__(self, index: int):
8920		return self.LoadPropertyUserGeneralRowColList[index]
8921
8922	def __iter__(self):
8923		yield from self.LoadPropertyUserGeneralRowColList
8924
8925	def __len__(self):
8926		return len(self.LoadPropertyUserGeneralRowColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

LoadPropertyUserGeneralRowColList: tuple[~T]
8875	@property
8876	def LoadPropertyUserGeneralRowColList(self) -> tuple[T]:
8877		if self._Entity.Count() <= 0:
8878			return ()
8879		thisClass = type(self._Entity._items[0]).__name__
8880		givenClass = T
8881		for subclass in T.__subclasses__():
8882			if subclass.__name__ == thisClass:
8883				givenClass = subclass
8884		return tuple([givenClass(loadPropertyUserGeneralRowCol) for loadPropertyUserGeneralRowCol in self._Entity])
def AddScenario(self, name: str = None) -> ~T:
8886	def AddScenario(self, name: str = None) -> T:
8887		return self._Entity.AddScenario(name)
def DeleteScenario(self, item1=None) -> bool:
8901	def DeleteScenario(self, item1 = None) -> bool:
8902		if isinstance(item1, int):
8903			return self._Entity.DeleteScenario(item1)
8904
8905		if isinstance(item1, str):
8906			return self._Entity.DeleteScenario(item1)
8907
8908		return self._Entity.DeleteScenario(item1)
8929class LoadPropertyUserGeneralBeamRowCol(LoadPropertyUserGeneralRowCol[LoadPropertyUserGeneralBeamDoubleRow]):
8930	def __init__(self, loadPropertyUserGeneralBeamRowCol: _api.LoadPropertyUserGeneralBeamRowCol):
8931		self._Entity = loadPropertyUserGeneralBeamRowCol
8932		self._CollectedClass = LoadPropertyUserGeneralBeamDoubleRow
8933
8934	@property
8935	def LoadPropertyUserGeneralBeamRowColList(self) -> tuple[LoadPropertyUserGeneralBeamDoubleRow]:
8936		return tuple([LoadPropertyUserGeneralBeamDoubleRow(loadPropertyUserGeneralBeamRowCol) for loadPropertyUserGeneralBeamRowCol in self._Entity])
8937
8938	@overload
8939	def DeleteScenario(self, scenarioId: int) -> bool: ...
8940
8941	@overload
8942	def DeleteScenario(self, scenarioName: str) -> bool: ...
8943
8944	@overload
8945	def Get(self, name: str) -> LoadPropertyUserGeneralBeamDoubleRow: ...
8946
8947	@overload
8948	def Get(self, id: int) -> LoadPropertyUserGeneralBeamDoubleRow: ...
8949
8950	def DeleteScenario(self, item1 = None) -> bool:
8951		if isinstance(item1, int):
8952			return bool(super().DeleteScenario(item1))
8953
8954		if isinstance(item1, str):
8955			return bool(super().DeleteScenario(item1))
8956
8957		return self._Entity.DeleteScenario(item1)
8958
8959	def Get(self, item1 = None) -> LoadPropertyUserGeneralBeamDoubleRow:
8960		if isinstance(item1, str):
8961			return LoadPropertyUserGeneralBeamDoubleRow(super().Get(item1))
8962
8963		if isinstance(item1, int):
8964			return LoadPropertyUserGeneralBeamDoubleRow(super().Get(item1))
8965
8966		return LoadPropertyUserGeneralBeamDoubleRow(self._Entity.Get(item1))
8967
8968	def __getitem__(self, index: int):
8969		return self.LoadPropertyUserGeneralBeamRowColList[index]
8970
8971	def __iter__(self):
8972		yield from self.LoadPropertyUserGeneralBeamRowColList
8973
8974	def __len__(self):
8975		return len(self.LoadPropertyUserGeneralBeamRowColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

LoadPropertyUserGeneralBeamRowCol( loadPropertyUserGeneralBeamRowCol: HyperX.Scripting.LoadPropertyUserGeneralBeamRowCol)
8930	def __init__(self, loadPropertyUserGeneralBeamRowCol: _api.LoadPropertyUserGeneralBeamRowCol):
8931		self._Entity = loadPropertyUserGeneralBeamRowCol
8932		self._CollectedClass = LoadPropertyUserGeneralBeamDoubleRow
LoadPropertyUserGeneralBeamRowColList: tuple[LoadPropertyUserGeneralBeamDoubleRow]
8934	@property
8935	def LoadPropertyUserGeneralBeamRowColList(self) -> tuple[LoadPropertyUserGeneralBeamDoubleRow]:
8936		return tuple([LoadPropertyUserGeneralBeamDoubleRow(loadPropertyUserGeneralBeamRowCol) for loadPropertyUserGeneralBeamRowCol in self._Entity])
def DeleteScenario(self, item1=None) -> bool:
8950	def DeleteScenario(self, item1 = None) -> bool:
8951		if isinstance(item1, int):
8952			return bool(super().DeleteScenario(item1))
8953
8954		if isinstance(item1, str):
8955			return bool(super().DeleteScenario(item1))
8956
8957		return self._Entity.DeleteScenario(item1)
def Get(self, item1=None) -> LoadPropertyUserGeneralBeamDoubleRow:
8959	def Get(self, item1 = None) -> LoadPropertyUserGeneralBeamDoubleRow:
8960		if isinstance(item1, str):
8961			return LoadPropertyUserGeneralBeamDoubleRow(super().Get(item1))
8962
8963		if isinstance(item1, int):
8964			return LoadPropertyUserGeneralBeamDoubleRow(super().Get(item1))
8965
8966		return LoadPropertyUserGeneralBeamDoubleRow(self._Entity.Get(item1))
class LoadPropertyUserGeneralBeam(LoadProperty):
8978class LoadPropertyUserGeneralBeam(LoadProperty):
8979	def __init__(self, loadPropertyUserGeneralBeam: _api.LoadPropertyUserGeneralBeam):
8980		self._Entity = loadPropertyUserGeneralBeam
8981
8982	@property
8983	def UserGeneralRows(self) -> LoadPropertyUserGeneralBeamRowCol:
8984		result = self._Entity.UserGeneralRows
8985		return LoadPropertyUserGeneralBeamRowCol(result) if result is not None else None
8986
8987	@property
8988	def IsIncludingThermal(self) -> bool:
8989		return self._Entity.IsIncludingThermal
8990
8991	@IsIncludingThermal.setter
8992	def IsIncludingThermal(self, value: bool) -> None:
8993		self._Entity.IsIncludingThermal = value

Represents an entity with an ID and Name.

LoadPropertyUserGeneralBeam( loadPropertyUserGeneralBeam: HyperX.Scripting.LoadPropertyUserGeneralBeam)
8979	def __init__(self, loadPropertyUserGeneralBeam: _api.LoadPropertyUserGeneralBeam):
8980		self._Entity = loadPropertyUserGeneralBeam
UserGeneralRows: LoadPropertyUserGeneralBeamRowCol
8982	@property
8983	def UserGeneralRows(self) -> LoadPropertyUserGeneralBeamRowCol:
8984		result = self._Entity.UserGeneralRows
8985		return LoadPropertyUserGeneralBeamRowCol(result) if result is not None else None
IsIncludingThermal: bool
8987	@property
8988	def IsIncludingThermal(self) -> bool:
8989		return self._Entity.IsIncludingThermal
class LoadPropertyUserGeneralBoltedRow(IdEntity):
8996class LoadPropertyUserGeneralBoltedRow(IdEntity):
8997	def __init__(self, loadPropertyUserGeneralBoltedRow: _api.LoadPropertyUserGeneralBoltedRow):
8998		self._Entity = loadPropertyUserGeneralBoltedRow
8999
9000	@property
9001	def LoadPropertyId(self) -> int:
9002		return self._Entity.LoadPropertyId
9003
9004	@property
9005	def LoadScenarioId(self) -> int:
9006		return self._Entity.LoadScenarioId
9007
9008	@property
9009	def Fx(self) -> float:
9010		return self._Entity.Fx
9011
9012	@property
9013	def Fy(self) -> float:
9014		return self._Entity.Fy
9015
9016	@property
9017	def Fz(self) -> float:
9018		return self._Entity.Fz
9019
9020	@property
9021	def Mx(self) -> float:
9022		return self._Entity.Mx
9023
9024	@property
9025	def My(self) -> float:
9026		return self._Entity.My
9027
9028	@property
9029	def Mz(self) -> float:
9030		return self._Entity.Mz
9031
9032	@property
9033	def NxBypass(self) -> float:
9034		return self._Entity.NxBypass
9035
9036	@property
9037	def NyBypass(self) -> float:
9038		return self._Entity.NyBypass
9039
9040	@property
9041	def NxyBypass(self) -> float:
9042		return self._Entity.NxyBypass
9043
9044	@property
9045	def LimitFactor(self) -> float:
9046		return self._Entity.LimitFactor
9047
9048	@property
9049	def UltimateFactor(self) -> float:
9050		return self._Entity.UltimateFactor
9051
9052	@Fx.setter
9053	def Fx(self, value: float) -> None:
9054		self._Entity.Fx = value
9055
9056	@Fy.setter
9057	def Fy(self, value: float) -> None:
9058		self._Entity.Fy = value
9059
9060	@Fz.setter
9061	def Fz(self, value: float) -> None:
9062		self._Entity.Fz = value
9063
9064	@Mx.setter
9065	def Mx(self, value: float) -> None:
9066		self._Entity.Mx = value
9067
9068	@My.setter
9069	def My(self, value: float) -> None:
9070		self._Entity.My = value
9071
9072	@Mz.setter
9073	def Mz(self, value: float) -> None:
9074		self._Entity.Mz = value
9075
9076	@NxBypass.setter
9077	def NxBypass(self, value: float) -> None:
9078		self._Entity.NxBypass = value
9079
9080	@NyBypass.setter
9081	def NyBypass(self, value: float) -> None:
9082		self._Entity.NyBypass = value
9083
9084	@NxyBypass.setter
9085	def NxyBypass(self, value: float) -> None:
9086		self._Entity.NxyBypass = value
9087
9088	@LimitFactor.setter
9089	def LimitFactor(self, value: float) -> None:
9090		self._Entity.LimitFactor = value
9091
9092	@UltimateFactor.setter
9093	def UltimateFactor(self, value: float) -> None:
9094		self._Entity.UltimateFactor = value

Represents an entity with an ID.

LoadPropertyUserGeneralBoltedRow( loadPropertyUserGeneralBoltedRow: HyperX.Scripting.LoadPropertyUserGeneralBoltedRow)
8997	def __init__(self, loadPropertyUserGeneralBoltedRow: _api.LoadPropertyUserGeneralBoltedRow):
8998		self._Entity = loadPropertyUserGeneralBoltedRow
LoadPropertyId: int
9000	@property
9001	def LoadPropertyId(self) -> int:
9002		return self._Entity.LoadPropertyId
LoadScenarioId: int
9004	@property
9005	def LoadScenarioId(self) -> int:
9006		return self._Entity.LoadScenarioId
Fx: float
9008	@property
9009	def Fx(self) -> float:
9010		return self._Entity.Fx
Fy: float
9012	@property
9013	def Fy(self) -> float:
9014		return self._Entity.Fy
Fz: float
9016	@property
9017	def Fz(self) -> float:
9018		return self._Entity.Fz
Mx: float
9020	@property
9021	def Mx(self) -> float:
9022		return self._Entity.Mx
My: float
9024	@property
9025	def My(self) -> float:
9026		return self._Entity.My
Mz: float
9028	@property
9029	def Mz(self) -> float:
9030		return self._Entity.Mz
NxBypass: float
9032	@property
9033	def NxBypass(self) -> float:
9034		return self._Entity.NxBypass
NyBypass: float
9036	@property
9037	def NyBypass(self) -> float:
9038		return self._Entity.NyBypass
NxyBypass: float
9040	@property
9041	def NxyBypass(self) -> float:
9042		return self._Entity.NxyBypass
LimitFactor: float
9044	@property
9045	def LimitFactor(self) -> float:
9046		return self._Entity.LimitFactor
UltimateFactor: float
9048	@property
9049	def UltimateFactor(self) -> float:
9050		return self._Entity.UltimateFactor
Inherited Members
IdEntity
Id
class LoadPropertyUserGeneralBoltedRowCol(hyperx.api.IdEntityCol[hyperx.api.LoadPropertyUserGeneralBoltedRow]):
9097class LoadPropertyUserGeneralBoltedRowCol(IdEntityCol[LoadPropertyUserGeneralBoltedRow]):
9098	def __init__(self, loadPropertyUserGeneralBoltedRowCol: _api.LoadPropertyUserGeneralBoltedRowCol):
9099		self._Entity = loadPropertyUserGeneralBoltedRowCol
9100		self._CollectedClass = LoadPropertyUserGeneralBoltedRow
9101
9102	@property
9103	def LoadPropertyUserGeneralBoltedRowColList(self) -> tuple[LoadPropertyUserGeneralBoltedRow]:
9104		return tuple([LoadPropertyUserGeneralBoltedRow(loadPropertyUserGeneralBoltedRowCol) for loadPropertyUserGeneralBoltedRowCol in self._Entity])
9105
9106	def AddScenario(self) -> None:
9107		'''
9108		Adds a load scenario with default values
9109		'''
9110		return self._Entity.AddScenario()
9111
9112	def DeleteScenario(self, scenarioId: int) -> bool:
9113		return self._Entity.DeleteScenario(scenarioId)
9114
9115	def __getitem__(self, index: int):
9116		return self.LoadPropertyUserGeneralBoltedRowColList[index]
9117
9118	def __iter__(self):
9119		yield from self.LoadPropertyUserGeneralBoltedRowColList
9120
9121	def __len__(self):
9122		return len(self.LoadPropertyUserGeneralBoltedRowColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

LoadPropertyUserGeneralBoltedRowCol( loadPropertyUserGeneralBoltedRowCol: HyperX.Scripting.LoadPropertyUserGeneralBoltedRowCol)
9098	def __init__(self, loadPropertyUserGeneralBoltedRowCol: _api.LoadPropertyUserGeneralBoltedRowCol):
9099		self._Entity = loadPropertyUserGeneralBoltedRowCol
9100		self._CollectedClass = LoadPropertyUserGeneralBoltedRow
LoadPropertyUserGeneralBoltedRowColList: tuple[LoadPropertyUserGeneralBoltedRow]
9102	@property
9103	def LoadPropertyUserGeneralBoltedRowColList(self) -> tuple[LoadPropertyUserGeneralBoltedRow]:
9104		return tuple([LoadPropertyUserGeneralBoltedRow(loadPropertyUserGeneralBoltedRowCol) for loadPropertyUserGeneralBoltedRowCol in self._Entity])
def AddScenario(self) -> None:
9106	def AddScenario(self) -> None:
9107		'''
9108		Adds a load scenario with default values
9109		'''
9110		return self._Entity.AddScenario()

Adds a load scenario with default values

def DeleteScenario(self, scenarioId: int) -> bool:
9112	def DeleteScenario(self, scenarioId: int) -> bool:
9113		return self._Entity.DeleteScenario(scenarioId)
class LoadPropertyUserGeneralBolted(LoadProperty):
9125class LoadPropertyUserGeneralBolted(LoadProperty):
9126	def __init__(self, loadPropertyUserGeneralBolted: _api.LoadPropertyUserGeneralBolted):
9127		self._Entity = loadPropertyUserGeneralBolted
9128
9129	@property
9130	def UserGeneralBoltedRows(self) -> LoadPropertyUserGeneralBoltedRowCol:
9131		result = self._Entity.UserGeneralBoltedRows
9132		return LoadPropertyUserGeneralBoltedRowCol(result) if result is not None else None

Represents an entity with an ID and Name.

LoadPropertyUserGeneralBolted( loadPropertyUserGeneralBolted: HyperX.Scripting.LoadPropertyUserGeneralBolted)
9126	def __init__(self, loadPropertyUserGeneralBolted: _api.LoadPropertyUserGeneralBolted):
9127		self._Entity = loadPropertyUserGeneralBolted
UserGeneralBoltedRows: LoadPropertyUserGeneralBoltedRowCol
9129	@property
9130	def UserGeneralBoltedRows(self) -> LoadPropertyUserGeneralBoltedRowCol:
9131		result = self._Entity.UserGeneralBoltedRows
9132		return LoadPropertyUserGeneralBoltedRowCol(result) if result is not None else None
class LoadPropertyUserGeneralBondedRow(IdEntity):
9135class LoadPropertyUserGeneralBondedRow(IdEntity):
9136	def __init__(self, loadPropertyUserGeneralBondedRow: _api.LoadPropertyUserGeneralBondedRow):
9137		self._Entity = loadPropertyUserGeneralBondedRow
9138
9139	@property
9140	def LoadPropertyId(self) -> int:
9141		return self._Entity.LoadPropertyId
9142
9143	@property
9144	def JointConceptId(self) -> types.JointConceptId:
9145		return types.JointConceptId[self._Entity.JointConceptId.ToString()]
9146
9147	@property
9148	def BondedBcId(self) -> int:
9149		return self._Entity.BondedBcId
9150
9151	@property
9152	def AxialType(self) -> types.BoundaryConditionType:
9153		return types.BoundaryConditionType[self._Entity.AxialType.ToString()]
9154
9155	@property
9156	def MomentType(self) -> types.BoundaryConditionType:
9157		return types.BoundaryConditionType[self._Entity.MomentType.ToString()]
9158
9159	@property
9160	def TransverseType(self) -> types.BoundaryConditionType:
9161		return types.BoundaryConditionType[self._Entity.TransverseType.ToString()]
9162
9163	@property
9164	def ShearType(self) -> types.BoundaryConditionType:
9165		return types.BoundaryConditionType[self._Entity.ShearType.ToString()]
9166
9167	@property
9168	def Axial(self) -> float:
9169		return self._Entity.Axial
9170
9171	@property
9172	def Moment(self) -> float:
9173		return self._Entity.Moment
9174
9175	@property
9176	def Transverse(self) -> float:
9177		return self._Entity.Transverse
9178
9179	@property
9180	def Shear(self) -> float:
9181		return self._Entity.Shear
9182
9183	@AxialType.setter
9184	def AxialType(self, value: types.BoundaryConditionType) -> None:
9185		self._Entity.AxialType = _types.BoundaryConditionType(value.value)
9186
9187	@MomentType.setter
9188	def MomentType(self, value: types.BoundaryConditionType) -> None:
9189		self._Entity.MomentType = _types.BoundaryConditionType(value.value)
9190
9191	@TransverseType.setter
9192	def TransverseType(self, value: types.BoundaryConditionType) -> None:
9193		self._Entity.TransverseType = _types.BoundaryConditionType(value.value)
9194
9195	@ShearType.setter
9196	def ShearType(self, value: types.BoundaryConditionType) -> None:
9197		self._Entity.ShearType = _types.BoundaryConditionType(value.value)
9198
9199	@Axial.setter
9200	def Axial(self, value: float) -> None:
9201		self._Entity.Axial = value
9202
9203	@Moment.setter
9204	def Moment(self, value: float) -> None:
9205		self._Entity.Moment = value
9206
9207	@Transverse.setter
9208	def Transverse(self, value: float) -> None:
9209		self._Entity.Transverse = value
9210
9211	@Shear.setter
9212	def Shear(self, value: float) -> None:
9213		self._Entity.Shear = value
9214
9215	def UpdateRow(self) -> None:
9216		return self._Entity.UpdateRow()

Represents an entity with an ID.

LoadPropertyUserGeneralBondedRow( loadPropertyUserGeneralBondedRow: HyperX.Scripting.LoadPropertyUserGeneralBondedRow)
9136	def __init__(self, loadPropertyUserGeneralBondedRow: _api.LoadPropertyUserGeneralBondedRow):
9137		self._Entity = loadPropertyUserGeneralBondedRow
LoadPropertyId: int
9139	@property
9140	def LoadPropertyId(self) -> int:
9141		return self._Entity.LoadPropertyId
JointConceptId: hyperx.api.types.JointConceptId
9143	@property
9144	def JointConceptId(self) -> types.JointConceptId:
9145		return types.JointConceptId[self._Entity.JointConceptId.ToString()]
BondedBcId: int
9147	@property
9148	def BondedBcId(self) -> int:
9149		return self._Entity.BondedBcId
9151	@property
9152	def AxialType(self) -> types.BoundaryConditionType:
9153		return types.BoundaryConditionType[self._Entity.AxialType.ToString()]
MomentType: hyperx.api.types.BoundaryConditionType
9155	@property
9156	def MomentType(self) -> types.BoundaryConditionType:
9157		return types.BoundaryConditionType[self._Entity.MomentType.ToString()]
TransverseType: hyperx.api.types.BoundaryConditionType
9159	@property
9160	def TransverseType(self) -> types.BoundaryConditionType:
9161		return types.BoundaryConditionType[self._Entity.TransverseType.ToString()]
9163	@property
9164	def ShearType(self) -> types.BoundaryConditionType:
9165		return types.BoundaryConditionType[self._Entity.ShearType.ToString()]
Axial: float
9167	@property
9168	def Axial(self) -> float:
9169		return self._Entity.Axial
Moment: float
9171	@property
9172	def Moment(self) -> float:
9173		return self._Entity.Moment
Transverse: float
9175	@property
9176	def Transverse(self) -> float:
9177		return self._Entity.Transverse
Shear: float
9179	@property
9180	def Shear(self) -> float:
9181		return self._Entity.Shear
def UpdateRow(self) -> None:
9215	def UpdateRow(self) -> None:
9216		return self._Entity.UpdateRow()
Inherited Members
IdEntity
Id
class LoadPropertyUserGeneralBondedRowCol(hyperx.api.IdEntityCol[hyperx.api.LoadPropertyUserGeneralBondedRow]):
9219class LoadPropertyUserGeneralBondedRowCol(IdEntityCol[LoadPropertyUserGeneralBondedRow]):
9220	def __init__(self, loadPropertyUserGeneralBondedRowCol: _api.LoadPropertyUserGeneralBondedRowCol):
9221		self._Entity = loadPropertyUserGeneralBondedRowCol
9222		self._CollectedClass = LoadPropertyUserGeneralBondedRow
9223
9224	@property
9225	def LoadPropertyUserGeneralBondedRowColList(self) -> tuple[LoadPropertyUserGeneralBondedRow]:
9226		return tuple([LoadPropertyUserGeneralBondedRow(loadPropertyUserGeneralBondedRowCol) for loadPropertyUserGeneralBondedRowCol in self._Entity])
9227
9228	def __getitem__(self, index: int):
9229		return self.LoadPropertyUserGeneralBondedRowColList[index]
9230
9231	def __iter__(self):
9232		yield from self.LoadPropertyUserGeneralBondedRowColList
9233
9234	def __len__(self):
9235		return len(self.LoadPropertyUserGeneralBondedRowColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

LoadPropertyUserGeneralBondedRowCol( loadPropertyUserGeneralBondedRowCol: HyperX.Scripting.LoadPropertyUserGeneralBondedRowCol)
9220	def __init__(self, loadPropertyUserGeneralBondedRowCol: _api.LoadPropertyUserGeneralBondedRowCol):
9221		self._Entity = loadPropertyUserGeneralBondedRowCol
9222		self._CollectedClass = LoadPropertyUserGeneralBondedRow
LoadPropertyUserGeneralBondedRowColList: tuple[LoadPropertyUserGeneralBondedRow]
9224	@property
9225	def LoadPropertyUserGeneralBondedRowColList(self) -> tuple[LoadPropertyUserGeneralBondedRow]:
9226		return tuple([LoadPropertyUserGeneralBondedRow(loadPropertyUserGeneralBondedRowCol) for loadPropertyUserGeneralBondedRowCol in self._Entity])
class LoadPropertyJoint(IdEntity):
9238class LoadPropertyJoint(IdEntity):
9239	def __init__(self, loadPropertyJoint: _api.LoadPropertyJoint):
9240		self._Entity = loadPropertyJoint
9241
9242	@property
9243	def UserGeneralBondedRows(self) -> LoadPropertyUserGeneralBondedRowCol:
9244		result = self._Entity.UserGeneralBondedRows
9245		return LoadPropertyUserGeneralBondedRowCol(result) if result is not None else None
9246
9247	@property
9248	def LoadPropertyId(self) -> int:
9249		return self._Entity.LoadPropertyId
9250
9251	@property
9252	def JConceptId(self) -> types.JointConceptId:
9253		return types.JointConceptId[self._Entity.JConceptId.ToString()]
9254
9255	@property
9256	def Ex(self) -> float:
9257		return self._Entity.Ex
9258
9259	@property
9260	def Kx(self) -> float:
9261		return self._Entity.Kx
9262
9263	@property
9264	def Kxy(self) -> float:
9265		return self._Entity.Kxy
9266
9267	@property
9268	def Temperature(self) -> float:
9269		return self._Entity.Temperature
9270
9271	@JConceptId.setter
9272	def JConceptId(self, value: types.JointConceptId) -> None:
9273		self._Entity.JConceptId = _types.JointConceptId(value.value)
9274
9275	@Ex.setter
9276	def Ex(self, value: float) -> None:
9277		self._Entity.Ex = value
9278
9279	@Kx.setter
9280	def Kx(self, value: float) -> None:
9281		self._Entity.Kx = value
9282
9283	@Kxy.setter
9284	def Kxy(self, value: float) -> None:
9285		self._Entity.Kxy = value
9286
9287	@Temperature.setter
9288	def Temperature(self, value: float) -> None:
9289		self._Entity.Temperature = value

Represents an entity with an ID.

LoadPropertyJoint(loadPropertyJoint: HyperX.Scripting.LoadPropertyJoint)
9239	def __init__(self, loadPropertyJoint: _api.LoadPropertyJoint):
9240		self._Entity = loadPropertyJoint
UserGeneralBondedRows: LoadPropertyUserGeneralBondedRowCol
9242	@property
9243	def UserGeneralBondedRows(self) -> LoadPropertyUserGeneralBondedRowCol:
9244		result = self._Entity.UserGeneralBondedRows
9245		return LoadPropertyUserGeneralBondedRowCol(result) if result is not None else None
LoadPropertyId: int
9247	@property
9248	def LoadPropertyId(self) -> int:
9249		return self._Entity.LoadPropertyId
JConceptId: hyperx.api.types.JointConceptId
9251	@property
9252	def JConceptId(self) -> types.JointConceptId:
9253		return types.JointConceptId[self._Entity.JConceptId.ToString()]
Ex: float
9255	@property
9256	def Ex(self) -> float:
9257		return self._Entity.Ex
Kx: float
9259	@property
9260	def Kx(self) -> float:
9261		return self._Entity.Kx
Kxy: float
9263	@property
9264	def Kxy(self) -> float:
9265		return self._Entity.Kxy
Temperature: float
9267	@property
9268	def Temperature(self) -> float:
9269		return self._Entity.Temperature
Inherited Members
IdEntity
Id
class LoadPropertyUserGeneralBonded(LoadProperty):
9292class LoadPropertyUserGeneralBonded(LoadProperty):
9293	def __init__(self, loadPropertyUserGeneralBonded: _api.LoadPropertyUserGeneralBonded):
9294		self._Entity = loadPropertyUserGeneralBonded
9295
9296	@property
9297	def LoadPropertyJoint(self) -> LoadPropertyJoint:
9298		result = self._Entity.LoadPropertyJoint
9299		return LoadPropertyJoint(result) if result is not None else None

Represents an entity with an ID and Name.

LoadPropertyUserGeneralBonded( loadPropertyUserGeneralBonded: HyperX.Scripting.LoadPropertyUserGeneralBonded)
9293	def __init__(self, loadPropertyUserGeneralBonded: _api.LoadPropertyUserGeneralBonded):
9294		self._Entity = loadPropertyUserGeneralBonded
LoadPropertyJoint: <property object at 0x000001C376225D50>
9296	@property
9297	def LoadPropertyJoint(self) -> LoadPropertyJoint:
9298		result = self._Entity.LoadPropertyJoint
9299		return LoadPropertyJoint(result) if result is not None else None
class LoadPropertyUserGeneralPanelDoubleRow(LoadPropertyUserGeneralDoubleRow):
9302class LoadPropertyUserGeneralPanelDoubleRow(LoadPropertyUserGeneralDoubleRow):
9303	def __init__(self, loadPropertyUserGeneralPanelDoubleRow: _api.LoadPropertyUserGeneralPanelDoubleRow):
9304		self._Entity = loadPropertyUserGeneralPanelDoubleRow
9305
9306	@property
9307	def MechanicalRow(self) -> LoadPropertyUserRow:
9308		thisClass = type(self._Entity.MechanicalRow).__name__
9309		givenClass = LoadPropertyUserRow
9310		for subclass in LoadPropertyUserRow.__subclasses__():
9311			if subclass.__name__ == thisClass:
9312				givenClass = subclass
9313		result = self._Entity.MechanicalRow
9314		return givenClass(result) if result is not None else None
9315
9316	@property
9317	def ThermalRow(self) -> LoadPropertyUserRow:
9318		thisClass = type(self._Entity.ThermalRow).__name__
9319		givenClass = LoadPropertyUserRow
9320		for subclass in LoadPropertyUserRow.__subclasses__():
9321			if subclass.__name__ == thisClass:
9322				givenClass = subclass
9323		result = self._Entity.ThermalRow
9324		return givenClass(result) if result is not None else None
9325
9326	@property
9327	def NxType(self) -> types.BoundaryConditionType:
9328		return types.BoundaryConditionType[self._Entity.NxType.ToString()]
9329
9330	@property
9331	def NyType(self) -> types.BoundaryConditionType:
9332		return types.BoundaryConditionType[self._Entity.NyType.ToString()]
9333
9334	@property
9335	def NxyType(self) -> types.BoundaryConditionType:
9336		return types.BoundaryConditionType[self._Entity.NxyType.ToString()]
9337
9338	@property
9339	def MxType(self) -> types.BoundaryConditionType:
9340		return types.BoundaryConditionType[self._Entity.MxType.ToString()]
9341
9342	@property
9343	def MyType(self) -> types.BoundaryConditionType:
9344		return types.BoundaryConditionType[self._Entity.MyType.ToString()]
9345
9346	@property
9347	def MxyType(self) -> types.BoundaryConditionType:
9348		return types.BoundaryConditionType[self._Entity.MxyType.ToString()]
9349
9350	@property
9351	def QxType(self) -> types.BoundaryConditionType:
9352		return types.BoundaryConditionType[self._Entity.QxType.ToString()]
9353
9354	@property
9355	def QyType(self) -> types.BoundaryConditionType:
9356		return types.BoundaryConditionType[self._Entity.QyType.ToString()]
9357
9358	def SetNxType(self, type: types.BoundaryConditionType) -> None:
9359		return self._Entity.SetNxType(_types.BoundaryConditionType(type.value))
9360
9361	def SetNyType(self, type: types.BoundaryConditionType) -> None:
9362		return self._Entity.SetNyType(_types.BoundaryConditionType(type.value))
9363
9364	def SetNxyType(self, type: types.BoundaryConditionType) -> None:
9365		return self._Entity.SetNxyType(_types.BoundaryConditionType(type.value))
9366
9367	def SetMxType(self, type: types.BoundaryConditionType) -> None:
9368		return self._Entity.SetMxType(_types.BoundaryConditionType(type.value))
9369
9370	def SetMyType(self, type: types.BoundaryConditionType) -> None:
9371		return self._Entity.SetMyType(_types.BoundaryConditionType(type.value))
9372
9373	def SetMxyType(self, type: types.BoundaryConditionType) -> None:
9374		return self._Entity.SetMxyType(_types.BoundaryConditionType(type.value))
9375
9376	def SetQxType(self, type: types.BoundaryConditionType) -> None:
9377		return self._Entity.SetQxType(_types.BoundaryConditionType(type.value))
9378
9379	def SetQyType(self, type: types.BoundaryConditionType) -> None:
9380		return self._Entity.SetQyType(_types.BoundaryConditionType(type.value))

Represents an entity with an ID and Name.

LoadPropertyUserGeneralPanelDoubleRow( loadPropertyUserGeneralPanelDoubleRow: HyperX.Scripting.LoadPropertyUserGeneralPanelDoubleRow)
9303	def __init__(self, loadPropertyUserGeneralPanelDoubleRow: _api.LoadPropertyUserGeneralPanelDoubleRow):
9304		self._Entity = loadPropertyUserGeneralPanelDoubleRow
MechanicalRow: LoadPropertyUserRow
9306	@property
9307	def MechanicalRow(self) -> LoadPropertyUserRow:
9308		thisClass = type(self._Entity.MechanicalRow).__name__
9309		givenClass = LoadPropertyUserRow
9310		for subclass in LoadPropertyUserRow.__subclasses__():
9311			if subclass.__name__ == thisClass:
9312				givenClass = subclass
9313		result = self._Entity.MechanicalRow
9314		return givenClass(result) if result is not None else None
ThermalRow: LoadPropertyUserRow
9316	@property
9317	def ThermalRow(self) -> LoadPropertyUserRow:
9318		thisClass = type(self._Entity.ThermalRow).__name__
9319		givenClass = LoadPropertyUserRow
9320		for subclass in LoadPropertyUserRow.__subclasses__():
9321			if subclass.__name__ == thisClass:
9322				givenClass = subclass
9323		result = self._Entity.ThermalRow
9324		return givenClass(result) if result is not None else None
9326	@property
9327	def NxType(self) -> types.BoundaryConditionType:
9328		return types.BoundaryConditionType[self._Entity.NxType.ToString()]
9330	@property
9331	def NyType(self) -> types.BoundaryConditionType:
9332		return types.BoundaryConditionType[self._Entity.NyType.ToString()]
9334	@property
9335	def NxyType(self) -> types.BoundaryConditionType:
9336		return types.BoundaryConditionType[self._Entity.NxyType.ToString()]
9338	@property
9339	def MxType(self) -> types.BoundaryConditionType:
9340		return types.BoundaryConditionType[self._Entity.MxType.ToString()]
9342	@property
9343	def MyType(self) -> types.BoundaryConditionType:
9344		return types.BoundaryConditionType[self._Entity.MyType.ToString()]
9346	@property
9347	def MxyType(self) -> types.BoundaryConditionType:
9348		return types.BoundaryConditionType[self._Entity.MxyType.ToString()]
9350	@property
9351	def QxType(self) -> types.BoundaryConditionType:
9352		return types.BoundaryConditionType[self._Entity.QxType.ToString()]
9354	@property
9355	def QyType(self) -> types.BoundaryConditionType:
9356		return types.BoundaryConditionType[self._Entity.QyType.ToString()]
def SetNxType(self, type: hyperx.api.types.BoundaryConditionType) -> None:
9358	def SetNxType(self, type: types.BoundaryConditionType) -> None:
9359		return self._Entity.SetNxType(_types.BoundaryConditionType(type.value))
def SetNyType(self, type: hyperx.api.types.BoundaryConditionType) -> None:
9361	def SetNyType(self, type: types.BoundaryConditionType) -> None:
9362		return self._Entity.SetNyType(_types.BoundaryConditionType(type.value))
def SetNxyType(self, type: hyperx.api.types.BoundaryConditionType) -> None:
9364	def SetNxyType(self, type: types.BoundaryConditionType) -> None:
9365		return self._Entity.SetNxyType(_types.BoundaryConditionType(type.value))
def SetMxType(self, type: hyperx.api.types.BoundaryConditionType) -> None:
9367	def SetMxType(self, type: types.BoundaryConditionType) -> None:
9368		return self._Entity.SetMxType(_types.BoundaryConditionType(type.value))
def SetMyType(self, type: hyperx.api.types.BoundaryConditionType) -> None:
9370	def SetMyType(self, type: types.BoundaryConditionType) -> None:
9371		return self._Entity.SetMyType(_types.BoundaryConditionType(type.value))
def SetMxyType(self, type: hyperx.api.types.BoundaryConditionType) -> None:
9373	def SetMxyType(self, type: types.BoundaryConditionType) -> None:
9374		return self._Entity.SetMxyType(_types.BoundaryConditionType(type.value))
def SetQxType(self, type: hyperx.api.types.BoundaryConditionType) -> None:
9376	def SetQxType(self, type: types.BoundaryConditionType) -> None:
9377		return self._Entity.SetQxType(_types.BoundaryConditionType(type.value))
def SetQyType(self, type: hyperx.api.types.BoundaryConditionType) -> None:
9379	def SetQyType(self, type: types.BoundaryConditionType) -> None:
9380		return self._Entity.SetQyType(_types.BoundaryConditionType(type.value))
9383class LoadPropertyUserGeneralPanelRowCol(LoadPropertyUserGeneralRowCol[LoadPropertyUserGeneralPanelDoubleRow]):
9384	def __init__(self, loadPropertyUserGeneralPanelRowCol: _api.LoadPropertyUserGeneralPanelRowCol):
9385		self._Entity = loadPropertyUserGeneralPanelRowCol
9386		self._CollectedClass = LoadPropertyUserGeneralPanelDoubleRow
9387
9388	@property
9389	def LoadPropertyUserGeneralPanelRowColList(self) -> tuple[LoadPropertyUserGeneralPanelDoubleRow]:
9390		return tuple([LoadPropertyUserGeneralPanelDoubleRow(loadPropertyUserGeneralPanelRowCol) for loadPropertyUserGeneralPanelRowCol in self._Entity])
9391
9392	@overload
9393	def DeleteScenario(self, scenarioId: int) -> bool: ...
9394
9395	@overload
9396	def DeleteScenario(self, scenarioName: str) -> bool: ...
9397
9398	@overload
9399	def Get(self, name: str) -> LoadPropertyUserGeneralPanelDoubleRow: ...
9400
9401	@overload
9402	def Get(self, id: int) -> LoadPropertyUserGeneralPanelDoubleRow: ...
9403
9404	def DeleteScenario(self, item1 = None) -> bool:
9405		if isinstance(item1, int):
9406			return bool(super().DeleteScenario(item1))
9407
9408		if isinstance(item1, str):
9409			return bool(super().DeleteScenario(item1))
9410
9411		return self._Entity.DeleteScenario(item1)
9412
9413	def Get(self, item1 = None) -> LoadPropertyUserGeneralPanelDoubleRow:
9414		if isinstance(item1, str):
9415			return LoadPropertyUserGeneralPanelDoubleRow(super().Get(item1))
9416
9417		if isinstance(item1, int):
9418			return LoadPropertyUserGeneralPanelDoubleRow(super().Get(item1))
9419
9420		return LoadPropertyUserGeneralPanelDoubleRow(self._Entity.Get(item1))
9421
9422	def __getitem__(self, index: int):
9423		return self.LoadPropertyUserGeneralPanelRowColList[index]
9424
9425	def __iter__(self):
9426		yield from self.LoadPropertyUserGeneralPanelRowColList
9427
9428	def __len__(self):
9429		return len(self.LoadPropertyUserGeneralPanelRowColList)

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as::

class Mapping(Generic[KT, VT]): def __getitem__(self, key: KT) -> VT: ... # Etc.

This class can then be used as follows::

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: try: return mapping[key] except KeyError: return default

LoadPropertyUserGeneralPanelRowCol( loadPropertyUserGeneralPanelRowCol: HyperX.Scripting.LoadPropertyUserGeneralPanelRowCol)
9384	def __init__(self, loadPropertyUserGeneralPanelRowCol: _api.LoadPropertyUserGeneralPanelRowCol):
9385		self._Entity = loadPropertyUserGeneralPanelRowCol
9386		self._CollectedClass = LoadPropertyUserGeneralPanelDoubleRow
LoadPropertyUserGeneralPanelRowColList: tuple[LoadPropertyUserGeneralPanelDoubleRow]
9388	@property
9389	def LoadPropertyUserGeneralPanelRowColList(self) -> tuple[LoadPropertyUserGeneralPanelDoubleRow]:
9390		return tuple([LoadPropertyUserGeneralPanelDoubleRow(loadPropertyUserGeneralPanelRowCol) for loadPropertyUserGeneralPanelRowCol in self._Entity])
def DeleteScenario(self, item1=None) -> bool:
9404	def DeleteScenario(self, item1 = None) -> bool:
9405		if isinstance(item1, int):
9406			return bool(super().DeleteScenario(item1))
9407
9408		if isinstance(item1, str):
9409			return bool(super().DeleteScenario(item1))
9410
9411		return self._Entity.DeleteScenario(item1)
def Get(self, item1=None) -> LoadPropertyUserGeneralPanelDoubleRow:
9413	def Get(self, item1 = None) -> LoadPropertyUserGeneralPanelDoubleRow:
9414		if isinstance(item1, str):
9415			return LoadPropertyUserGeneralPanelDoubleRow(super().Get(item1))
9416
9417		if isinstance(item1, int):
9418			return LoadPropertyUserGeneralPanelDoubleRow(super().Get(item1))
9419
9420		return LoadPropertyUserGeneralPanelDoubleRow(self._Entity.Get(item1))
class LoadPropertyUserGeneralPanel(LoadProperty):
9432class LoadPropertyUserGeneralPanel(LoadProperty):
9433	def __init__(self, loadPropertyUserGeneralPanel: _api.LoadPropertyUserGeneralPanel):
9434		self._Entity = loadPropertyUserGeneralPanel
9435
9436	@property
9437	def UserGeneralRows(self) -> LoadPropertyUserGeneralPanelRowCol:
9438		result = self._Entity.UserGeneralRows
9439		return LoadPropertyUserGeneralPanelRowCol(result) if result is not None else None
9440
9441	@property
9442	def IsIncludingThermal(self) -> bool:
9443		return self._Entity.IsIncludingThermal
9444
9445	@IsIncludingThermal.setter
9446	def IsIncludingThermal(self, value: bool) -> None:
9447		self._Entity.IsIncludingThermal = value
9448
9449	def SetIsZeroCurvature(self, isZeroCurvature: bool) -> None:
9450		return self._Entity.SetIsZeroCurvature(isZeroCurvature)

Represents an entity with an ID and Name.

LoadPropertyUserGeneralPanel( loadPropertyUserGeneralPanel: HyperX.Scripting.LoadPropertyUserGeneralPanel)
9433	def __init__(self, loadPropertyUserGeneralPanel: _api.LoadPropertyUserGeneralPanel):
9434		self._Entity = loadPropertyUserGeneralPanel
UserGeneralRows: LoadPropertyUserGeneralPanelRowCol
9436	@property
9437	def UserGeneralRows(self) -> LoadPropertyUserGeneralPanelRowCol:
9438		result = self._Entity.UserGeneralRows
9439		return LoadPropertyUserGeneralPanelRowCol(result) if result is not None else None
IsIncludingThermal: bool
9441	@property
9442	def IsIncludingThermal(self) -> bool:
9443		return self._Entity.IsIncludingThermal
def SetIsZeroCurvature(self, isZeroCurvature: bool) -> None:
9449	def SetIsZeroCurvature(self, isZeroCurvature: bool) -> None:
9450		return self._Entity.SetIsZeroCurvature(isZeroCurvature)
class JointSelectionDesignResult(JointDesignResult):
9453class JointSelectionDesignResult(JointDesignResult):
9454	def __init__(self, jointSelectionDesignResult: _api.JointSelectionDesignResult):
9455		self._Entity = jointSelectionDesignResult
9456
9457	@property
9458	def JointSelectionId(self) -> types.JointSelectionId:
9459		return types.JointSelectionId[self._Entity.JointSelectionId.ToString()]

Represents an entity with an ID.

JointSelectionDesignResult( jointSelectionDesignResult: HyperX.Scripting.JointSelectionDesignResult)
9454	def __init__(self, jointSelectionDesignResult: _api.JointSelectionDesignResult):
9455		self._Entity = jointSelectionDesignResult
JointSelectionId: hyperx.api.types.JointSelectionId
9457	@property
9458	def JointSelectionId(self) -> types.JointSelectionId:
9459		return types.JointSelectionId[self._Entity.JointSelectionId.ToString()]
Inherited Members
IdEntity
Id
class JointFastenerDesignResult(JointSelectionDesignResult):
9462class JointFastenerDesignResult(JointSelectionDesignResult):
9463	def __init__(self, jointFastenerDesignResult: _api.JointFastenerDesignResult):
9464		self._Entity = jointFastenerDesignResult
9465
9466	@property
9467	def FastenerBoltId(self) -> int:
9468		return self._Entity.FastenerBoltId
9469
9470	@property
9471	def FastenerCodeId(self) -> int:
9472		return self._Entity.FastenerCodeId

Represents an entity with an ID.

JointFastenerDesignResult( jointFastenerDesignResult: HyperX.Scripting.JointFastenerDesignResult)
9463	def __init__(self, jointFastenerDesignResult: _api.JointFastenerDesignResult):
9464		self._Entity = jointFastenerDesignResult
FastenerBoltId: int
9466	@property
9467	def FastenerBoltId(self) -> int:
9468		return self._Entity.FastenerBoltId
FastenerCodeId: int
9470	@property
9471	def FastenerCodeId(self) -> int:
9472		return self._Entity.FastenerCodeId
class JointMaterialDesignResult(JointSelectionDesignResult):
9475class JointMaterialDesignResult(JointSelectionDesignResult):
9476	def __init__(self, jointMaterialDesignResult: _api.JointMaterialDesignResult):
9477		self._Entity = jointMaterialDesignResult
9478
9479	@property
9480	def MaterialId(self) -> int:
9481		return self._Entity.MaterialId
9482
9483	@property
9484	def MaterialType(self) -> types.MaterialType:
9485		'''
9486		Represents a material's type.
9487		'''
9488		return types.MaterialType[self._Entity.MaterialType.ToString()]

Represents an entity with an ID.

JointMaterialDesignResult( jointMaterialDesignResult: HyperX.Scripting.JointMaterialDesignResult)
9476	def __init__(self, jointMaterialDesignResult: _api.JointMaterialDesignResult):
9477		self._Entity = jointMaterialDesignResult
MaterialId: int
9479	@property
9480	def MaterialId(self) -> int:
9481		return self._Entity.MaterialId
MaterialType: hyperx.api.types.MaterialType
9483	@property
9484	def MaterialType(self) -> types.MaterialType:
9485		'''
9486		Represents a material's type.
9487		'''
9488		return types.MaterialType[self._Entity.MaterialType.ToString()]

Represents a material's type.

class JointRangeDesignResult(JointDesignResult):
9491class JointRangeDesignResult(JointDesignResult):
9492	def __init__(self, jointRangeDesignResult: _api.JointRangeDesignResult):
9493		self._Entity = jointRangeDesignResult
9494
9495	@property
9496	def JointRangeId(self) -> types.JointRangeId:
9497		return types.JointRangeId[self._Entity.JointRangeId.ToString()]
9498
9499	@property
9500	def Value(self) -> float:
9501		return self._Entity.Value

Represents an entity with an ID.

JointRangeDesignResult(jointRangeDesignResult: HyperX.Scripting.JointRangeDesignResult)
9492	def __init__(self, jointRangeDesignResult: _api.JointRangeDesignResult):
9493		self._Entity = jointRangeDesignResult
JointRangeId: hyperx.api.types.JointRangeId
9495	@property
9496	def JointRangeId(self) -> types.JointRangeId:
9497		return types.JointRangeId[self._Entity.JointRangeId.ToString()]
Value: float
9499	@property
9500	def Value(self) -> float:
9501		return self._Entity.Value
Inherited Members
IdEntity
Id
class JointRivetDesignResult(JointSelectionDesignResult):
9504class JointRivetDesignResult(JointSelectionDesignResult):
9505	def __init__(self, jointRivetDesignResult: _api.JointRivetDesignResult):
9506		self._Entity = jointRivetDesignResult
9507
9508	@property
9509	def RivetId(self) -> int:
9510		return self._Entity.RivetId
9511
9512	@property
9513	def RivetDiameterId(self) -> int:
9514		return self._Entity.RivetDiameterId

Represents an entity with an ID.

JointRivetDesignResult(jointRivetDesignResult: HyperX.Scripting.JointRivetDesignResult)
9505	def __init__(self, jointRivetDesignResult: _api.JointRivetDesignResult):
9506		self._Entity = jointRivetDesignResult
RivetId: int
9508	@property
9509	def RivetId(self) -> int:
9510		return self._Entity.RivetId
RivetDiameterId: int
9512	@property
9513	def RivetDiameterId(self) -> int:
9514		return self._Entity.RivetDiameterId
class Environment(abc.ABC):
9517class Environment(ABC):
9518	'''
9519	Represents HyperX's execution environment (where HyperX is installed).
9520	'''
9521	def __init__(self, environment: _api.Environment):
9522		self._Entity = environment
9523
9524	def SetLocation(location: str) -> None:
9525		return _api.Environment.SetLocation(location)
9526
9527	def Initialize() -> None:
9528		'''
9529		Initialize the HyperX scripting environment.
9530		'''
9531		return _api.Environment.Initialize()

Represents HyperX's execution environment (where HyperX is installed).

Environment(environment: HyperX.Scripting.Environment)
9521	def __init__(self, environment: _api.Environment):
9522		self._Entity = environment
def SetLocation(location: str) -> None:
9524	def SetLocation(location: str) -> None:
9525		return _api.Environment.SetLocation(location)
def Initialize() -> None:
9527	def Initialize() -> None:
9528		'''
9529		Initialize the HyperX scripting environment.
9530		'''
9531		return _api.Environment.Initialize()

Initialize the HyperX scripting environment.

class FailureCriterionSetting(FailureSetting):
9534class FailureCriterionSetting(FailureSetting):
9535	'''
9536	Setting for a Failure Criteria.
9537	'''
9538	def __init__(self, failureCriterionSetting: _api.FailureCriterionSetting):
9539		self._Entity = failureCriterionSetting

Setting for a Failure Criteria.

FailureCriterionSetting(failureCriterionSetting: HyperX.Scripting.FailureCriterionSetting)
9538	def __init__(self, failureCriterionSetting: _api.FailureCriterionSetting):
9539		self._Entity = failureCriterionSetting
class FailureModeSetting(FailureSetting):
9542class FailureModeSetting(FailureSetting):
9543	'''
9544	Setting for a Failure Mode.
9545	'''
9546	def __init__(self, failureModeSetting: _api.FailureModeSetting):
9547		self._Entity = failureModeSetting

Setting for a Failure Mode.

FailureModeSetting(failureModeSetting: HyperX.Scripting.FailureModeSetting)
9546	def __init__(self, failureModeSetting: _api.FailureModeSetting):
9547		self._Entity = failureModeSetting
class HelperFunctions(abc.ABC):
9550class HelperFunctions(ABC):
9551	def __init__(self, helperFunctions: _api.HelperFunctions):
9552		self._Entity = helperFunctions
9553
9554	def NullableSingle(input: float) -> float:
9555		return _api.HelperFunctions.NullableSingle(input)
HelperFunctions(helperFunctions: HyperX.Scripting.HelperFunctions)
9551	def __init__(self, helperFunctions: _api.HelperFunctions):
9552		self._Entity = helperFunctions
def NullableSingle(input: float) -> float:
9554	def NullableSingle(input: float) -> float:
9555		return _api.HelperFunctions.NullableSingle(input)
class IBulkUpdatableEntity:
9558class IBulkUpdatableEntity:
9559	def __init__(self, iBulkUpdatableEntity: _api.IBulkUpdatableEntity):
9560		self._Entity = iBulkUpdatableEntity
9561
9562	pass
IBulkUpdatableEntity(iBulkUpdatableEntity: HyperX.Scripting.IBulkUpdatableEntity)
9559	def __init__(self, iBulkUpdatableEntity: _api.IBulkUpdatableEntity):
9560		self._Entity = iBulkUpdatableEntity
class LaminatePlyData:
9565class LaminatePlyData:
9566	'''
9567	Per ply data for Laminate materials
9568	'''
9569	def __init__(self, laminatePlyData: _api.LaminatePlyData):
9570		self._Entity = laminatePlyData
9571
9572	@property
9573	def MaterialId(self) -> int:
9574		return self._Entity.MaterialId
9575
9576	@property
9577	def PlyId(self) -> int:
9578		return self._Entity.PlyId
9579
9580	@property
9581	def PlyMaterialId(self) -> int:
9582		return self._Entity.PlyMaterialId
9583
9584	@property
9585	def PlyMaterialType(self) -> types.MaterialType:
9586		'''
9587		Represents a material's type.
9588		'''
9589		return types.MaterialType[self._Entity.PlyMaterialType.ToString()]
9590
9591	@property
9592	def Angle(self) -> float:
9593		return self._Entity.Angle
9594
9595	@property
9596	def Thickness(self) -> float:
9597		return self._Entity.Thickness
9598
9599	@property
9600	def IsFabric(self) -> bool:
9601		return self._Entity.IsFabric
9602
9603	@property
9604	def FamilyPlyId(self) -> int:
9605		return self._Entity.FamilyPlyId
9606
9607	@property
9608	def OriginalPlyId(self) -> int:
9609		return self._Entity.OriginalPlyId
9610
9611	@property
9612	def OriginalFamilyPlyId(self) -> int:
9613		return self._Entity.OriginalFamilyPlyId
9614
9615	@property
9616	def DisplaySequenceId(self) -> int:
9617		return self._Entity.DisplaySequenceId
9618
9619	@property
9620	def PlyStiffenerSubType(self) -> types.PlyStiffenerSubType:
9621		return types.PlyStiffenerSubType[self._Entity.PlyStiffenerSubType.ToString()]
9622
9623	@property
9624	def Object1(self) -> bool:
9625		return self._Entity.Object1
9626
9627	@property
9628	def Object2(self) -> bool:
9629		return self._Entity.Object2
9630
9631	@property
9632	def Object3(self) -> bool:
9633		return self._Entity.Object3
9634
9635	@property
9636	def IsInverted(self) -> bool:
9637		return self._Entity.IsInverted
9638
9639	@property
9640	def IsFullStructure(self) -> bool:
9641		return self._Entity.IsFullStructure
9642
9643	@property
9644	def UseTrueFiberDirection(self) -> bool:
9645		return self._Entity.UseTrueFiberDirection
9646
9647	@property
9648	def IsInFoot(self) -> bool:
9649		return self._Entity.IsInFoot
9650
9651	@property
9652	def IsInWeb(self) -> bool:
9653		return self._Entity.IsInWeb
9654
9655	@property
9656	def IsInCap(self) -> bool:
9657		return self._Entity.IsInCap
9658
9659	def SetMaterial(self, matId: int) -> bool:
9660		return self._Entity.SetMaterial(matId)
9661
9662	def SetAngle(self, angle: float) -> bool:
9663		return self._Entity.SetAngle(angle)

Per ply data for Laminate materials

LaminatePlyData(laminatePlyData: HyperX.Scripting.LaminatePlyData)
9569	def __init__(self, laminatePlyData: _api.LaminatePlyData):
9570		self._Entity = laminatePlyData
MaterialId: int
9572	@property
9573	def MaterialId(self) -> int:
9574		return self._Entity.MaterialId
PlyId: int
9576	@property
9577	def PlyId(self) -> int:
9578		return self._Entity.PlyId
PlyMaterialId: int
9580	@property
9581	def PlyMaterialId(self) -> int:
9582		return self._Entity.PlyMaterialId
PlyMaterialType: hyperx.api.types.MaterialType
9584	@property
9585	def PlyMaterialType(self) -> types.MaterialType:
9586		'''
9587		Represents a material's type.
9588		'''
9589		return types.MaterialType[self._Entity.PlyMaterialType.ToString()]

Represents a material's type.

Angle: float
9591	@property
9592	def Angle(self) -> float:
9593		return self._Entity.Angle
Thickness: float
9595	@property
9596	def Thickness(self) -> float:
9597		return self._Entity.Thickness
IsFabric: bool
9599	@property
9600	def IsFabric(self) -> bool:
9601		return self._Entity.IsFabric
FamilyPlyId: int
9603	@property
9604	def FamilyPlyId(self) -> int:
9605		return self._Entity.FamilyPlyId
OriginalPlyId: int
9607	@property
9608	def OriginalPlyId(self) -> int:
9609		return self._Entity.OriginalPlyId
OriginalFamilyPlyId: int
9611	@property
9612	def OriginalFamilyPlyId(self) -> int:
9613		return self._Entity.OriginalFamilyPlyId
DisplaySequenceId: int
9615	@property
9616	def DisplaySequenceId(self) -> int:
9617		return self._Entity.DisplaySequenceId
PlyStiffenerSubType: hyperx.api.types.PlyStiffenerSubType
9619	@property
9620	def PlyStiffenerSubType(self) -> types.PlyStiffenerSubType:
9621		return types.PlyStiffenerSubType[self._Entity.PlyStiffenerSubType.ToString()]
Object1: bool
9623	@property
9624	def Object1(self) -> bool:
9625		return self._Entity.Object1
Object2: bool
9627	@property
9628	def Object2(self) -> bool:
9629		return self._Entity.Object2
Object3: bool
9631	@property
9632	def Object3(self) -> bool:
9633		return self._Entity.Object3
IsInverted: bool
9635	@property
9636	def IsInverted(self) -> bool:
9637		return self._Entity.IsInverted
IsFullStructure: bool
9639	@property
9640	def IsFullStructure(self) -> bool:
9641		return self._Entity.IsFullStructure
UseTrueFiberDirection: bool
9643	@property
9644	def UseTrueFiberDirection(self) -> bool:
9645		return self._Entity.UseTrueFiberDirection
IsInFoot: bool
9647	@property
9648	def IsInFoot(self) -> bool:
9649		return self._Entity.IsInFoot
IsInWeb: bool
9651	@property
9652	def IsInWeb(self) -> bool:
9653		return self._Entity.IsInWeb
IsInCap: bool
9655	@property
9656	def IsInCap(self) -> bool:
9657		return self._Entity.IsInCap
def SetMaterial(self, matId: int) -> bool:
9659	def SetMaterial(self, matId: int) -> bool:
9660		return self._Entity.SetMaterial(matId)
def SetAngle(self, angle: float) -> bool:
9662	def SetAngle(self, angle: float) -> bool:
9663		return self._Entity.SetAngle(angle)
class Beam(Zone):
9666class Beam(Zone):
9667	def __init__(self, beam: _api.Beam):
9668		self._Entity = beam
9669
9670	@property
9671	def Length(self) -> float:
9672		return self._Entity.Length
9673
9674	@property
9675	def Phi(self) -> float:
9676		return self._Entity.Phi
9677
9678	@property
9679	def K1(self) -> float:
9680		return self._Entity.K1
9681
9682	@property
9683	def K2(self) -> float:
9684		return self._Entity.K2
9685
9686	@property
9687	def ReferencePlane(self) -> types.ReferencePlaneBeam:
9688		return types.ReferencePlaneBeam[self._Entity.ReferencePlane.ToString()]
9689
9690	@Phi.setter
9691	def Phi(self, value: float) -> None:
9692		self._Entity.Phi = value
9693
9694	@K1.setter
9695	def K1(self, value: float) -> None:
9696		self._Entity.K1 = value
9697
9698	@K2.setter
9699	def K2(self, value: float) -> None:
9700		self._Entity.K2 = value
9701
9702	@ReferencePlane.setter
9703	def ReferencePlane(self, value: types.ReferencePlaneBeam) -> None:
9704		self._Entity.ReferencePlane = _types.ReferencePlaneBeam(value.value)

Abstract for regular Zones (not Panel Segments).

Beam(beam: HyperX.Scripting.Beam)
9667	def __init__(self, beam: _api.Beam):
9668		self._Entity = beam
Length: float
9670	@property
9671	def Length(self) -> float:
9672		return self._Entity.Length
Phi: float
9674	@property
9675	def Phi(self) -> float:
9676		return self._Entity.Phi
K1: float
9678	@property
9679	def K1(self) -> float:
9680		return self._Entity.K1
K2: float
9682	@property
9683	def K2(self) -> float:
9684		return self._Entity.K2
ReferencePlane: hyperx.api.types.ReferencePlaneBeam
9686	@property
9687	def ReferencePlane(self) -> types.ReferencePlaneBeam:
9688		return types.ReferencePlaneBeam[self._Entity.ReferencePlane.ToString()]
class ZoneBulkUpdaterBase(BulkUpdaterBase):
9707class ZoneBulkUpdaterBase(BulkUpdaterBase):
9708	def __init__(self, zoneBulkUpdaterBase: _api.ZoneBulkUpdaterBase):
9709		self._Entity = zoneBulkUpdaterBase
ZoneBulkUpdaterBase(zoneBulkUpdaterBase: HyperX.Scripting.ZoneBulkUpdaterBase[])
9708	def __init__(self, zoneBulkUpdaterBase: _api.ZoneBulkUpdaterBase):
9709		self._Entity = zoneBulkUpdaterBase
Inherited Members
BulkUpdaterBase
Update
class BeamBulkUpdater(ZoneBulkUpdaterBase):
9712class BeamBulkUpdater(ZoneBulkUpdaterBase):
9713	def __init__(self, beamBulkUpdater: _api.BeamBulkUpdater):
9714		self._Entity = beamBulkUpdater
9715
9716	def GetBulkUpdater(application: Application, items: list[Beam]) -> BeamBulkUpdater:
9717		itemsList = List[_api.Beam]()
9718		if items is not None:
9719			for thing in items:
9720				if thing is not None:
9721					itemsList.Add(thing._Entity)
9722		return BeamBulkUpdater(_api.BeamBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
BeamBulkUpdater(beamBulkUpdater: HyperX.Scripting.BeamBulkUpdater)
9713	def __init__(self, beamBulkUpdater: _api.BeamBulkUpdater):
9714		self._Entity = beamBulkUpdater
def GetBulkUpdater( application: Application, items: list[Beam]) -> BeamBulkUpdater:
9716	def GetBulkUpdater(application: Application, items: list[Beam]) -> BeamBulkUpdater:
9717		itemsList = List[_api.Beam]()
9718		if items is not None:
9719			for thing in items:
9720				if thing is not None:
9721					itemsList.Add(thing._Entity)
9722		return BeamBulkUpdater(_api.BeamBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
Inherited Members
BulkUpdaterBase
Update
class Panel(Zone):
9725class Panel(Zone):
9726	def __init__(self, panel: _api.Panel):
9727		self._Entity = panel
9728
9729	@property
9730	def Area(self) -> float:
9731		return self._Entity.Area
9732
9733	@property
9734	def ReferencePlane(self) -> types.ReferencePlanePanel:
9735		return types.ReferencePlanePanel[self._Entity.ReferencePlane.ToString()]
9736
9737	@property
9738	def AddedOffset(self) -> float:
9739		return self._Entity.AddedOffset
9740
9741	@property
9742	def YSpan(self) -> float:
9743		return self._Entity.YSpan
9744
9745	@property
9746	def IsCurved(self) -> bool:
9747		return self._Entity.IsCurved
9748
9749	@property
9750	def Radius(self) -> float:
9751		return self._Entity.Radius
9752
9753	@property
9754	def IsFullCylinder(self) -> bool:
9755		return self._Entity.IsFullCylinder
9756
9757	@property
9758	def BucklingMode(self) -> types.ZoneBucklingMode:
9759		return types.ZoneBucklingMode[self._Entity.BucklingMode.ToString()]
9760
9761	@property
9762	def PerformLocalPostbuckling(self) -> bool:
9763		return self._Entity.PerformLocalPostbuckling
9764
9765	@property
9766	def A11Required(self) -> float:
9767		return self._Entity.A11Required
9768
9769	@property
9770	def A22Required(self) -> float:
9771		return self._Entity.A22Required
9772
9773	@property
9774	def A33Required(self) -> float:
9775		return self._Entity.A33Required
9776
9777	@property
9778	def D11Required(self) -> float:
9779		return self._Entity.D11Required
9780
9781	@property
9782	def D22Required(self) -> float:
9783		return self._Entity.D22Required
9784
9785	@property
9786	def D33Required(self) -> float:
9787		return self._Entity.D33Required
9788
9789	@property
9790	def A11Auto(self) -> float:
9791		return self._Entity.A11Auto
9792
9793	@property
9794	def A22Auto(self) -> float:
9795		return self._Entity.A22Auto
9796
9797	@property
9798	def A33Auto(self) -> float:
9799		return self._Entity.A33Auto
9800
9801	@property
9802	def D11Auto(self) -> float:
9803		return self._Entity.D11Auto
9804
9805	@property
9806	def D22Auto(self) -> float:
9807		return self._Entity.D22Auto
9808
9809	@property
9810	def D33Auto(self) -> float:
9811		return self._Entity.D33Auto
9812
9813	@property
9814	def Ey(self) -> float:
9815		return self._Entity.Ey
9816
9817	@property
9818	def Kx(self) -> float:
9819		return self._Entity.Kx
9820
9821	@property
9822	def Ky(self) -> float:
9823		return self._Entity.Ky
9824
9825	@property
9826	def HoneycombCoreAngle(self) -> float:
9827		return self._Entity.HoneycombCoreAngle
9828
9829	@ReferencePlane.setter
9830	def ReferencePlane(self, value: types.ReferencePlanePanel) -> None:
9831		self._Entity.ReferencePlane = _types.ReferencePlanePanel(value.value)
9832
9833	@AddedOffset.setter
9834	def AddedOffset(self, value: float) -> None:
9835		self._Entity.AddedOffset = value
9836
9837	@YSpan.setter
9838	def YSpan(self, value: float) -> None:
9839		self._Entity.YSpan = value
9840
9841	@IsCurved.setter
9842	def IsCurved(self, value: bool) -> None:
9843		self._Entity.IsCurved = value
9844
9845	@Radius.setter
9846	def Radius(self, value: float) -> None:
9847		self._Entity.Radius = value
9848
9849	@IsFullCylinder.setter
9850	def IsFullCylinder(self, value: bool) -> None:
9851		self._Entity.IsFullCylinder = value
9852
9853	@BucklingMode.setter
9854	def BucklingMode(self, value: types.ZoneBucklingMode) -> None:
9855		self._Entity.BucklingMode = _types.ZoneBucklingMode(value.value)
9856
9857	@PerformLocalPostbuckling.setter
9858	def PerformLocalPostbuckling(self, value: bool) -> None:
9859		self._Entity.PerformLocalPostbuckling = value
9860
9861	@A11Required.setter
9862	def A11Required(self, value: float) -> None:
9863		self._Entity.A11Required = value
9864
9865	@A22Required.setter
9866	def A22Required(self, value: float) -> None:
9867		self._Entity.A22Required = value
9868
9869	@A33Required.setter
9870	def A33Required(self, value: float) -> None:
9871		self._Entity.A33Required = value
9872
9873	@D11Required.setter
9874	def D11Required(self, value: float) -> None:
9875		self._Entity.D11Required = value
9876
9877	@D22Required.setter
9878	def D22Required(self, value: float) -> None:
9879		self._Entity.D22Required = value
9880
9881	@D33Required.setter
9882	def D33Required(self, value: float) -> None:
9883		self._Entity.D33Required = value
9884
9885	@Ey.setter
9886	def Ey(self, value: float) -> None:
9887		self._Entity.Ey = value
9888
9889	@Kx.setter
9890	def Kx(self, value: float) -> None:
9891		self._Entity.Kx = value
9892
9893	@Ky.setter
9894	def Ky(self, value: float) -> None:
9895		self._Entity.Ky = value
9896
9897	@HoneycombCoreAngle.setter
9898	def HoneycombCoreAngle(self, value: float) -> None:
9899		self._Entity.HoneycombCoreAngle = value

Abstract for regular Zones (not Panel Segments).

Panel(panel: HyperX.Scripting.Panel)
9726	def __init__(self, panel: _api.Panel):
9727		self._Entity = panel
Area: float
9729	@property
9730	def Area(self) -> float:
9731		return self._Entity.Area
ReferencePlane: hyperx.api.types.ReferencePlanePanel
9733	@property
9734	def ReferencePlane(self) -> types.ReferencePlanePanel:
9735		return types.ReferencePlanePanel[self._Entity.ReferencePlane.ToString()]
AddedOffset: float
9737	@property
9738	def AddedOffset(self) -> float:
9739		return self._Entity.AddedOffset
YSpan: float
9741	@property
9742	def YSpan(self) -> float:
9743		return self._Entity.YSpan
IsCurved: bool
9745	@property
9746	def IsCurved(self) -> bool:
9747		return self._Entity.IsCurved
Radius: float
9749	@property
9750	def Radius(self) -> float:
9751		return self._Entity.Radius
IsFullCylinder: bool
9753	@property
9754	def IsFullCylinder(self) -> bool:
9755		return self._Entity.IsFullCylinder
BucklingMode: hyperx.api.types.ZoneBucklingMode
9757	@property
9758	def BucklingMode(self) -> types.ZoneBucklingMode:
9759		return types.ZoneBucklingMode[self._Entity.BucklingMode.ToString()]
PerformLocalPostbuckling: bool
9761	@property
9762	def PerformLocalPostbuckling(self) -> bool:
9763		return self._Entity.PerformLocalPostbuckling
A11Required: float
9765	@property
9766	def A11Required(self) -> float:
9767		return self._Entity.A11Required
A22Required: float
9769	@property
9770	def A22Required(self) -> float:
9771		return self._Entity.A22Required
A33Required: float
9773	@property
9774	def A33Required(self) -> float:
9775		return self._Entity.A33Required
D11Required: float
9777	@property
9778	def D11Required(self) -> float:
9779		return self._Entity.D11Required
D22Required: float
9781	@property
9782	def D22Required(self) -> float:
9783		return self._Entity.D22Required
D33Required: float
9785	@property
9786	def D33Required(self) -> float:
9787		return self._Entity.D33Required
A11Auto: float
9789	@property
9790	def A11Auto(self) -> float:
9791		return self._Entity.A11Auto
A22Auto: float
9793	@property
9794	def A22Auto(self) -> float:
9795		return self._Entity.A22Auto
A33Auto: float
9797	@property
9798	def A33Auto(self) -> float:
9799		return self._Entity.A33Auto
D11Auto: float
9801	@property
9802	def D11Auto(self) -> float:
9803		return self._Entity.D11Auto
D22Auto: float
9805	@property
9806	def D22Auto(self) -> float:
9807		return self._Entity.D22Auto
D33Auto: float
9809	@property
9810	def D33Auto(self) -> float:
9811		return self._Entity.D33Auto
Ey: float
9813	@property
9814	def Ey(self) -> float:
9815		return self._Entity.Ey
Kx: float
9817	@property
9818	def Kx(self) -> float:
9819		return self._Entity.Kx
Ky: float
9821	@property
9822	def Ky(self) -> float:
9823		return self._Entity.Ky
HoneycombCoreAngle: float
9825	@property
9826	def HoneycombCoreAngle(self) -> float:
9827		return self._Entity.HoneycombCoreAngle
class PanelBulkUpdater(ZoneBulkUpdaterBase):
9902class PanelBulkUpdater(ZoneBulkUpdaterBase):
9903	def __init__(self, panelBulkUpdater: _api.PanelBulkUpdater):
9904		self._Entity = panelBulkUpdater
9905
9906	def GetBulkUpdater(application: Application, items: list[Panel]) -> PanelBulkUpdater:
9907		itemsList = List[_api.Panel]()
9908		if items is not None:
9909			for thing in items:
9910				if thing is not None:
9911					itemsList.Add(thing._Entity)
9912		return PanelBulkUpdater(_api.PanelBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
PanelBulkUpdater(panelBulkUpdater: HyperX.Scripting.PanelBulkUpdater)
9903	def __init__(self, panelBulkUpdater: _api.PanelBulkUpdater):
9904		self._Entity = panelBulkUpdater
def GetBulkUpdater( application: Application, items: list[Panel]) -> PanelBulkUpdater:
9906	def GetBulkUpdater(application: Application, items: list[Panel]) -> PanelBulkUpdater:
9907		itemsList = List[_api.Panel]()
9908		if items is not None:
9909			for thing in items:
9910				if thing is not None:
9911					itemsList.Add(thing._Entity)
9912		return PanelBulkUpdater(_api.PanelBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
Inherited Members
BulkUpdaterBase
Update
class PanelSegmentBulkUpdater(ZoneBulkUpdaterBase):
9915class PanelSegmentBulkUpdater(ZoneBulkUpdaterBase):
9916	def __init__(self, panelSegmentBulkUpdater: _api.PanelSegmentBulkUpdater):
9917		self._Entity = panelSegmentBulkUpdater
9918
9919	def GetBulkUpdater(application: Application, items: list[PanelSegment]) -> PanelSegmentBulkUpdater:
9920		itemsList = List[_api.PanelSegment]()
9921		if items is not None:
9922			for thing in items:
9923				if thing is not None:
9924					itemsList.Add(thing._Entity)
9925		return PanelSegmentBulkUpdater(_api.PanelSegmentBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
PanelSegmentBulkUpdater(panelSegmentBulkUpdater: HyperX.Scripting.PanelSegmentBulkUpdater)
9916	def __init__(self, panelSegmentBulkUpdater: _api.PanelSegmentBulkUpdater):
9917		self._Entity = panelSegmentBulkUpdater
def GetBulkUpdater( application: Application, items: list[PanelSegment]) -> PanelSegmentBulkUpdater:
9919	def GetBulkUpdater(application: Application, items: list[PanelSegment]) -> PanelSegmentBulkUpdater:
9920		itemsList = List[_api.PanelSegment]()
9921		if items is not None:
9922			for thing in items:
9923				if thing is not None:
9924					itemsList.Add(thing._Entity)
9925		return PanelSegmentBulkUpdater(_api.PanelSegmentBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
Inherited Members
BulkUpdaterBase
Update
class ZoneBulkUpdater(ZoneBulkUpdaterBase):
9928class ZoneBulkUpdater(ZoneBulkUpdaterBase):
9929	def __init__(self, zoneBulkUpdater: _api.ZoneBulkUpdater):
9930		self._Entity = zoneBulkUpdater
9931
9932	def GetBulkUpdater(application: Application, items: list[Zone]) -> ZoneBulkUpdater:
9933		itemsList = List[_api.Zone]()
9934		if items is not None:
9935			for thing in items:
9936				if thing is not None:
9937					itemsList.Add(thing._Entity)
9938		return ZoneBulkUpdater(_api.ZoneBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
ZoneBulkUpdater(zoneBulkUpdater: HyperX.Scripting.ZoneBulkUpdater)
9929	def __init__(self, zoneBulkUpdater: _api.ZoneBulkUpdater):
9930		self._Entity = zoneBulkUpdater
def GetBulkUpdater( application: Application, items: list[Zone]) -> ZoneBulkUpdater:
9932	def GetBulkUpdater(application: Application, items: list[Zone]) -> ZoneBulkUpdater:
9933		itemsList = List[_api.Zone]()
9934		if items is not None:
9935			for thing in items:
9936				if thing is not None:
9937					itemsList.Add(thing._Entity)
9938		return ZoneBulkUpdater(_api.ZoneBulkUpdater.GetBulkUpdater(application._Entity, itemsList))
Inherited Members
BulkUpdaterBase
Update